Skip to content

refactor!: rename command #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MihalyToth20 merged 6 commits into from
Apr 10, 2026
Merged

refactor!: rename command #188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
91d81cf
refactor!: migrate CLI command from xano to caly-xano
MihalyToth20 Apr 10, 2026
d10df86
chore: improve skill installation
MihalyToth20 Apr 10, 2026
7c26d1e
chore: adjust default models for opencode config templates
MihalyToth20 Apr 10, 2026
24888af
doc: update the guide templates to use correct commands
MihalyToth20 Apr 10, 2026
cf564bb
Merge remote-tracking branch 'origin/main' into dev
MihalyToth20 Apr 10, 2026
037ca67
chore: pre-release cleanup
MihalyToth20 Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/nasty-facts-hammer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@calycode/xano-skills": patch
---

chore: improve installability
5 changes: 5 additions & 0 deletions .changeset/rapid-lions-jump.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@calycode/cli": minor
---

refactor: **BREAKING CHANGE** rename CLI command from `xano` to `caly-xano`; update scripts, CI, and docs to use `caly-xano`
Comment on lines +2 to +5
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 10, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify historical convention for breaking changes in this repo's changesets
# Expected: determine whether BREAKING CHANGE entries have been released as major or minor.
rg -n -C2 'BREAKING CHANGE|\"@calycode/cli\": (major|minor|patch)' .changeset

Repository: calycode/xano-tools

Length of output: 199

🏁 Script executed:

#!/bin/bash
# List all changeset files and their contents to understand breaking change patterns
echo "=== Changeset files with BREAKING CHANGE ==="
rg -l "BREAKING CHANGE" .changeset/*.md

echo -e "\n=== Content of all changeset files ==="
find .changeset -name "*.md" -type f ! -name "package.json" ! -name "config.json" | while read file; do
  echo "--- $file ---"
  cat "$file"
  echo ""
done

Repository: calycode/xano-tools

Length of output: 2290

Confirm whether breaking changes in pre-1.0 packages use minor or major bumps.

This changeset marks the CLI command rename as a breaking change but declares @calycode/cli as minor. While the repository has historically not used major bumps (all changes are patch or minor), this is the first entry with a BREAKING CHANGE marker. If breaking changes should release as major, this should be corrected before publishing. Alternatively, if the repo intentionally treats pre-1.0 breaking changes as minor, this should be explicitly documented.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.changeset/rapid-lions-jump.md around lines 2 - 5, The changeset for
"@calycode/cli" declares a BREAKING CHANGE (renaming CLI command from `xano` to
`caly-xano`) but is labeled `minor`; verify the repository policy for pre-1.0
semantic versioning and then update the changeset accordingly: if breaking
changes must use `major` bumps, change the version tag from `minor` to `major`
in the .changeset entry for "@calycode/cli"; if the repo intentionally treats
pre-1.0 breaks as `minor`, add/update documentation (or a CONTRIBUTING/RELEASE
note) stating that pre-1.0 breaking changes are released as `minor` and add an
inline comment in the changeset explaining this decision to avoid confusion.

Copy link
Copy Markdown
Collaborator Author

@MihalyToth20 MihalyToth20 Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's fine we are far from anything like a major release, and there's no actual user anyways just yet other than internal team members.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MihalyToth20, understood! That's a perfectly reasonable approach for a pre-1.0 package with only internal consumers. I'll note this for future reviews.

✏️ Learnings added 
Learnt from: MihalyToth20
Repo: calycode/xano-tools PR: 188
File: .changeset/rapid-lions-jump.md:2-5
Timestamp: 2026-04-10T08:03:44.875Z
Learning: In the calycode/xano-tools repository, breaking changes for `calycode/cli` and other packages are intentionally released as `minor` (not `major`) bumps because the packages are pre-1.0 and currently only used by internal team members. Do not flag `minor` changesets for breaking changes as incorrect in this repo.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

🧠 Learnings used 
Learnt from: CR
Repo: calycode/xano-tools PR: 0
File: packages/xano-skills/AGENTS.md:0-0
Timestamp: 2026-02-08T03:34:24.694Z
Learning: Use the caly-xano-cli skill for CalyCode CLI commands and Xano automation

Learnt from: CR
Repo: calycode/xano-tools PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-02-08T03:34:16.104Z
Learning: Use Changesets for semantic versioning and changelog management

10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ pnpm install
pnpm build
# 4. Run any command
xano
caly-xano
```

> _(Optional)_ If you want the CLI globally available during development:
Expand All @@ -61,17 +61,17 @@ I have been astonished by the shadcn/ui CLI and the core principles of code dist
1. Scaffold the registry or build it manually by obeying the schemas (https://calycode.com/schemas/registry/registry.json).
```
xano registry-scaffold
caly-xano registry-scaffold
```
2. Serve your registry locally or host it on an object storage (or [advanced] recreate a Xano api that would deliver the required JSON objects on demand --> this could allow you to add auth as well)
```
xano serve-registry
caly-xano serve-registry
```
3. Use the registry and it's content in `xano`
3. Use the registry and it's content in `caly-xano`
```
Comment on lines 68 to 73
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add fenced code languages to satisfy markdownlint MD040.

The updated fenced blocks in this section should declare a language.

Proposed fix 
-   ```
+   ```bash
    caly-xano serve registry
    ```
@@
-   ```
+   ```bash
    caly-xano registry add <comma-separated component names> --registry <registry url>
    ```
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 68-68: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

[warning] 73-73: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 68 - 73, Update the fenced code blocks in README.md
around the caly-xano examples to declare a language (use "bash") and apply the
corrected command text from the proposal: change "caly-xano serve-registry" to
"caly-xano serve registry" and ensure the other block shows "caly-xano registry
add <comma-separated component names> --registry <registry url>" inside a
```bash fenced block; edit the two code fences enclosing those commands
accordingly.

xano registry-add --components <coma separated component names> --registry <registry url>
caly-xano registry-add --components <coma separated component names> --registry <registry url>
```
Comment on lines +64 to 75
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Use the current command syntax in registry examples (these forms are stale).

The README still shows hyphenated forms (registry-scaffold, serve-registry, registry-add) and --components, while current docs/CLI usage is space-separated subcommands with positional components (e.g., registry add [components...]). This will mislead users and can fail on copy-paste.

Proposed fix 
-   caly-xano registry-scaffold
+   caly-xano registry scaffold
@@
-   caly-xano serve-registry
+   caly-xano serve registry
@@
-3. Use the registry and it's content in `caly-xano`
+3. Use the registry and its content in `caly-xano`
    ```
-   caly-xano registry-add --components <coma separated component names> --registry <registry url>
+   caly-xano registry add <comma-separated component names> --registry <registry url>
    ```
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
caly-xano registry-scaffold
```
2. Serve your registry locally or host it on an object storage (or [advanced] recreate a Xano api that would deliver the required JSON objects on demand --> this could allow you to add auth as well)
```
xano serve-registry
caly-xano serve-registry
```
3. Use the registry and it's content in `xano`
3. Use the registry and it's content in `caly-xano`
```
xano registry-add --components <coma separated component names> --registry <registry url>
caly-xano registry-add --components <coma separated component names> --registry <registry url>
```
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 68-68: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

[warning] 73-73: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 64 - 75, Update the README command examples to the
current CLI syntax: replace the hyphenated commands "caly-xano
registry-scaffold", "caly-xano serve-registry", and "caly-xano registry-add
--components <...>" with space-separated subcommands and positional components,
e.g. "caly-xano registry scaffold", "caly-xano registry serve" (or the correct
subcommand name for serving), and "caly-xano registry add <comma-separated
component names> --registry <registry url>", and also fix the typo "coma" ->
"comma-separated".

> [!NOTE] > **Notes:**
Expand Down
10 changes: 5 additions & 5 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ pnpm install
pnpm build

# 4. Run any command
xano
caly-xano
```

> _(Optional)_ If you want the CLI globally available during development:
Expand All @@ -65,17 +65,17 @@ I have been astonished by the shadcn/ui CLI and the core principles of code dist

1. Scaffold the registry or build it manually by obeying the schemas (https://calycode.com/schemas/registry/registry.json).
```
xano registry-scaffold
caly-xano registry-scaffold
```
2. Serve your registry locally or host it on an object storage (or [advanced] recreate a Xano api that would deliver the required JSON objects on demand --> this could allow you to add auth as well)

```
xano serve-registry
caly-xano serve-registry
```

3. Use the registry and it's content in `xano`
3. Use the registry and it's content in `caly-xano`
```
xano registry-add --components <coma separated component names> --registry <registry url>
caly-xano registry-add --components <coma separated component names> --registry <registry url>
```
Comment on lines 72 to 79
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix fenced code language and typo in registry example.

Line 72/77 should include a fence language (MD040), and Line 78 should say “comma separated”.

💡 Suggested patch 
-   ```
+   ```term
    caly-xano serve-registry
    ```

 3. Use the registry and it's content in `caly-xano`
-   ```
-   caly-xano registry-add --components <coma separated component names> --registry <registry url>
+   ```term
+   caly-xano registry-add --components <comma separated component names> --registry <registry url>
    ```
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
```
xano serve-registry
caly-xano serve-registry
```
3. Use the registry and it's content in `xano`
3. Use the registry and it's content in `caly-xano`
```
xano registry-add --components <coma separated component names> --registry <registry url>
caly-xano registry-add --components <coma separated component names> --registry <registry url>
```
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 72-72: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

[warning] 77-77: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/README.md` around lines 72 - 79, Add a fence language to the fenced code
blocks for the registry examples and fix the typo "coma" to "comma" in the
registry-add example; specifically, update the code fences around the caly-xano
serve-registry and caly-xano registry-add blocks to include a language label
(e.g., "term") and change the placeholder in the caly-xano registry-add
--components <coma separated component names> --registry <registry url> to
<comma separated component names> so the MD040 lint warning is resolved.


> [!NOTE] > **Notes:**
Expand Down
2 changes: 1 addition & 1 deletion docs/_sidebar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- [xano - the core command](xano.md)
- [caly-xano - the core command](xano.md)
- **Commands**

- [init](commands/init.md)
Expand Down
8 changes: 4 additions & 4 deletions docs/commands/backup-export.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> #### Backup Xano Workspace via Metadata API

```term
$ xano backup export [options]
$ caly-xano backup export [options]
```
### Options

Expand All @@ -18,10 +18,10 @@ $ xano backup export [options]

### backup export --help
```term
$ xano backup export --help
$ caly-xano backup export --help
Backup Xano Workspace via Metadata API

Usage: xano backup export [options]
Usage: caly-xano backup export [options]

Options:
├─ --instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
Expand All @@ -30,6 +30,6 @@ Options:
├─ --print-output-dir Expose usable output path for further reuse.
└─ -h, --help display help for command

Run 'xano <command> --help' for detailed usage.
Run 'caly-xano <command> --help' for detailed usage.
https://github.com/calycode/xano-tools | https://links.calycode.com/discord
```
8 changes: 4 additions & 4 deletions docs/commands/backup-restore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> #### Restore a backup to a Xano Workspace via Metadata API. DANGER! This action will override all business logic and restore the original v1 branch. Data will be also restored from the backup file.

```term
$ xano backup restore [options]
$ caly-xano backup restore [options]
```
### Options

Expand All @@ -16,17 +16,17 @@ $ xano backup restore [options]

### backup restore --help
```term
$ xano backup restore --help
$ caly-xano backup restore --help
Restore a backup to a Xano Workspace via Metadata API. DANGER! This action will override all business logic and restore the original v1 branch. Data will be also restored from the backup file.

Usage: xano backup restore [options]
Usage: caly-xano backup restore [options]

Options:
├─ --instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
├─ --workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
├─ -S, --source-backup <file> Local path to the backup file to restore.
└─ -h, --help display help for command

Run 'xano <command> --help' for detailed usage.
Run 'caly-xano <command> --help' for detailed usage.
https://github.com/calycode/xano-tools | https://links.calycode.com/discord
```
8 changes: 4 additions & 4 deletions docs/commands/backup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
> #### Backup and restoration operations.

```term
$ xano backup [options]
$ caly-xano backup [options]
```

### backup --help
```term
$ xano backup --help
$ caly-xano backup --help
Backup and restoration operations.

Usage: xano backup [options] [command]
Usage: caly-xano backup [options] [command]

Options:
└─ -h, --help display help for command
Expand All @@ -21,6 +21,6 @@ Commands:
├─ restore Restore a backup to a Xano Workspace via Metadata API. DA...
└─ help display help for command

Run 'xano <command> --help' for detailed usage.
Run 'caly-xano <command> --help' for detailed usage.
https://github.com/calycode/xano-tools | https://links.calycode.com/discord
```
8 changes: 4 additions & 4 deletions docs/commands/context-show.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@
> #### Show the current known context.

```term
$ xano context show [options]
$ caly-xano context show [options]
```

### context show --help
```term
$ xano context show --help
$ caly-xano context show --help
Show the current known context.

Usage: xano context show [options]
Usage: caly-xano context show [options]

Options:
└─ -h, --help display help for command

Run 'xano <command> --help' for detailed usage.
Run 'caly-xano <command> --help' for detailed usage.
https://github.com/calycode/xano-tools | https://links.calycode.com/discord
```
8 changes: 4 additions & 4 deletions docs/commands/context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
> #### Context related operations.

```term
$ xano context [options]
$ caly-xano context [options]
```

### context --help
```term
$ xano context --help
$ caly-xano context --help
Context related operations.

Usage: xano context [options] [command]
Usage: caly-xano context [options] [command]

Options:
└─ -h, --help display help for command
Expand All @@ -20,6 +20,6 @@ Commands:
├─ show Show the current known context.
└─ help display help for command

Run 'xano <command> --help' for detailed usage.
Run 'caly-xano <command> --help' for detailed usage.
https://github.com/calycode/xano-tools | https://links.calycode.com/discord
```
8 changes: 4 additions & 4 deletions docs/commands/generate-codegen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> #### Create a library based on the OpenAPI specification. If the openapi specification has not yet been generated, this will generate that as well as the first step. Supports **all** openapi tools generators + orval clients.

```term
$ xano generate codegen [options]
$ caly-xano generate codegen [options]
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 10, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Remove shell prompt marker in command-only fenced block.

Line 6 triggers MD014 (commands-show-output). Keep command-only examples without $ to avoid markdownlint noise/failures.

💡 Suggested patch 
- $ caly-xano generate codegen [options]
+ caly-xano generate codegen [options]
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
$ caly-xano generate codegen [options]
caly-xano generate codegen [options]
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 6-6: Dollar signs used before commands without showing output

(MD014, commands-show-output)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/commands/generate-codegen.md` at line 6, The fenced code block contains
a shell prompt marker ("$ caly-xano generate codegen [options]") which triggers
markdownlint MD014; remove the leading "$ " so the block contains "caly-xano
generate codegen [options]" instead, i.e., update the command-only fenced block
in docs/commands/generate-codegen.md to omit the shell prompt marker.

Copy link
Copy Markdown
Collaborator Author

@MihalyToth20 MihalyToth20 Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's just used for styling. The term is a custom identifier for a docsify.js plugin that creates animated terminal-like documentation block. So no issues here.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MihalyToth20, thanks for the clarification! That makes sense — since term is a custom docsify.js plugin identifier for animated terminal-like blocks, the $ prefix is intentional styling and MD014 doesn't apply here. I'll remember this for future reviews.

✏️ Learnings added 
Learnt from: MihalyToth20
Repo: calycode/xano-tools PR: 188
File: docs/commands/generate-codegen.md:6-6
Timestamp: 2026-04-10T08:04:27.109Z
Learning: In calycode/xano-tools, fenced code blocks with the `term` identifier (e.g., ```term) are rendered by a custom docsify.js plugin as animated terminal-like documentation blocks. The `$` shell prompt marker inside these blocks is intentional for styling purposes and is NOT a markdownlint MD014 violation. Do not flag `$` prefixes in `term` fenced blocks.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

🧠 Learnings used 
Learnt from: CR
Repo: calycode/xano-tools PR: 0
File: packages/xano-skills/AGENTS.md:0-0
Timestamp: 2026-02-08T03:34:24.694Z
Learning: Use the caly-xano-cli skill for CalyCode CLI commands and Xano automation

Learnt from: MihalyToth20
Repo: calycode/xano-tools PR: 188
File: .changeset/rapid-lions-jump.md:2-5
Timestamp: 2026-04-10T08:03:44.875Z
Learning: In the calycode/xano-tools repository, breaking changes for `calycode/cli` and other packages are intentionally released as `minor` (not `major`) bumps because the packages are pre-1.0 and currently only used by internal team members. Do not flag `minor` changesets for breaking changes as incorrect in this repo.

Learnt from: CR
Repo: calycode/xano-tools PR: 0
File: packages/opencode-templates/AGENTS.md:0-0
Timestamp: 2026-02-08T03:34:25.992Z
Learning: Applies to packages/opencode-templates/**/*.xano : Add descriptions to all fields and parameters in XanoScript tables, functions, and APIs

```
### Options

Expand All @@ -26,10 +26,10 @@ $ xano generate codegen [options]

### generate codegen --help
```term
$ xano generate codegen --help
$ caly-xano generate codegen --help
Create a library based on the OpenAPI specification. If the openapi specification has not yet been generated, this will generate that as well as the first step. Supports **all** openapi tools generators + orval clients.

Usage: xano generate codegen [options] [passthroughArgs...]
Usage: caly-xano generate codegen [options] [passthroughArgs...]

Arguments:
└─ passthroughArgs Additional arguments to pass to the generator. For options for each generator see https://openapi-generator.tech/docs/usage#generate this also accepts Orval additional arguments e.g. --mock etc. See Orval docs as well: https://orval.dev/reference/configuration/full-example
Expand All @@ -45,6 +45,6 @@ Options:
├─ --debug Specify this flag in order to allow logging. Logs will appear in output/_logs. Default: false
└─ -h, --help display help for command

Run 'xano <command> --help' for detailed usage.
Run 'caly-xano <command> --help' for detailed usage.
https://github.com/calycode/xano-tools | https://links.calycode.com/discord
```
8 changes: 4 additions & 4 deletions docs/commands/generate-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> #### Collect all descriptions, and internal documentation from a Xano instance and combine it into a nice documentation suite that can be hosted on a static hosting.

```term
$ xano generate docs [options]
$ caly-xano generate docs [options]
```
### Options

Expand All @@ -24,10 +24,10 @@ $ xano generate docs [options]

### generate docs --help
```term
$ xano generate docs --help
$ caly-xano generate docs --help
Collect all descriptions, and internal documentation from a Xano instance and combine it into a nice documentation suite that can be hosted on a static hosting.

Usage: xano generate docs [options]
Usage: caly-xano generate docs [options]

Options:
├─ -I, --input <file> Workspace schema file (.yaml [legacy] or .json) from a local source, if present.
Expand All @@ -39,6 +39,6 @@ Options:
├─ -F, --fetch Forces fetching the workspace schema from the Xano instance via metadata API.
└─ -h, --help display help for command

Run 'xano <command> --help' for detailed usage.
Run 'caly-xano <command> --help' for detailed usage.
https://github.com/calycode/xano-tools | https://links.calycode.com/discord
```
8 changes: 4 additions & 4 deletions docs/commands/generate-repo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> #### Process Xano workspace into repo structure. We use the export-schema metadata API to offer the full details. However that is enriched with the Xanoscripts after Xano 2.0 release.
```term
$ xano generate repo [options]
$ caly-xano generate repo [options]
```
### Options

Expand All @@ -24,10 +24,10 @@ $ xano generate repo [options]

### generate repo --help
```term
$ xano generate repo --help
$ caly-xano generate repo --help
Process Xano workspace into repo structure. We use the export-schema metadata API to offer the full details. However that is enriched with the Xanoscripts after Xano 2.0 release.
Usage: xano generate repo [options]
Usage: caly-xano generate repo [options]
Options:
├─ -I, --input <file> Workspace schema file (.yaml [legacy] or .json) from a local source, if present.
Expand All @@ -39,6 +39,6 @@ Options:
├─ -F, --fetch Forces fetching the workspace schema from the Xano instance via metadata API.
└─ -h, --help display help for command
Run 'xano <command> --help' for detailed usage.
Run 'caly-xano <command> --help' for detailed usage.
https://github.com/calycode/xano-tools | https://links.calycode.com/discord
```
8 changes: 4 additions & 4 deletions docs/commands/generate-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> #### Update and generate OpenAPI spec(s) for the current context, or all API groups simultaneously. This generates an opinionated API documentation powered by Scalar API Reference. + this command brings the Swagger docs to OAS 3.1+ version.

```term
$ xano generate spec [options]
$ caly-xano generate spec [options]
```
### Options

Expand All @@ -24,10 +24,10 @@ $ xano generate spec [options]

### generate spec --help
```term
$ xano generate spec --help
$ caly-xano generate spec --help
Update and generate OpenAPI spec(s) for the current context, or all API groups simultaneously. This generates an opinionated API documentation powered by Scalar API Reference. + this command brings the Swagger docs to OAS 3.1+ version.

Usage: xano generate spec [options]
Usage: caly-xano generate spec [options]

Options:
├─ --instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
Expand All @@ -39,6 +39,6 @@ Options:
├─ --include-tables Requests table schema fetching and inclusion into the generate spec. By default tables are not included.
└─ -h, --help display help for command

Run 'xano <command> --help' for detailed usage.
Run 'caly-xano <command> --help' for detailed usage.
https://github.com/calycode/xano-tools | https://links.calycode.com/discord
```
8 changes: 4 additions & 4 deletions docs/commands/generate-xanoscript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> #### Process Xano workspace into repo structure. Supports table, function and apis as of know. Xano VSCode extension is the preferred solution over this command. Outputs of this process are also included in the default repo generation command.

```term
$ xano generate xanoscript [options]
$ caly-xano generate xanoscript [options]
```
### Options

Expand All @@ -18,10 +18,10 @@ $ xano generate xanoscript [options]

### generate xanoscript --help
```term
$ xano generate xanoscript --help
$ caly-xano generate xanoscript --help
Process Xano workspace into repo structure. Supports table, function and apis as of know. Xano VSCode extension is the preferred solution over this command. Outputs of this process are also included in the default repo generation command.

Usage: xano generate xanoscript [options]
Usage: caly-xano generate xanoscript [options]

Options:
├─ --instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
Expand All @@ -30,6 +30,6 @@ Options:
├─ --print-output-dir Expose usable output path for further reuse.
└─ -h, --help display help for command

Run 'xano <command> --help' for detailed usage.
Run 'caly-xano <command> --help' for detailed usage.
https://github.com/calycode/xano-tools | https://links.calycode.com/discord
```
Loading