Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .changeset/three-singers-rush.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
"@repo/types": patch
"@repo/utils": patch
"@calycode/core": patch
"@calycode/cli": patch
---

chore: added context7 config, fixed doc generation script, added copy docs button
21 changes: 21 additions & 0 deletions context7.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"$schema": "https://context7.com/schema/context7.json",
"projectTitle": "@calycode/cli",
"description": "Community-driven CLI tool for Xano Backend, to automate documentation generation, version control, testing and so much more.",
"branch": "main",
"excludeFolders": [
"scripts",
"util-resources",
".github",
".changeset",
"packages/**/src",
"packages/**/__tests__"
],
"excludeFiles": [],
"rules": [
"Use when required to run commands to backup a xano workspace",
"Use when extracting xanoscript from Xano workspace",
"Use when generating improved OpenAPI specification from Xano workspace",
"Use when needed to generate client side code for a Xano backend"
]
}
9 changes: 3 additions & 6 deletions docs/commands/export-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,9 @@ Usage: xano export-backup [options]
Backup Xano Workspace via Metadata API

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.
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
Interface.
--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.
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
--print-output-dir Expose usable output path for further reuse.
-h, --help display help for command
```
22 changes: 8 additions & 14 deletions docs/commands/generate-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,24 +31,18 @@ $ xano generate-code [options]
$ xano generate-code --help
Usage: xano generate-code [options]

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.
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.

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.
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
Interface.
--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.
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
--group <name> API group name. Same as on Xano Interface.
--all Regenerate for all API groups in the workspace / branch of the current context.
--print-output-dir Expose usable output path for further reuse.
--generator <generator> Generator to use, see all options at:
https://openapi-generator.tech/docs/generators
--args <args> Additional arguments to pass to the generator. See
https://openapi-generator.tech/docs/usage#generate
--debug Specify this flag in order to allow logging. Logs will appear in output/_logs.
Default: false
--generator <generator> Generator to use, see all options at: https://openapi-generator.tech/docs/generators
--args <args> Additional arguments to pass to the generator. See https://openapi-generator.tech/docs/usage#generate
--debug Specify this flag in order to allow logging. Logs will appear in output/_logs. Default: false
-h, --help display help for command
```
9 changes: 3 additions & 6 deletions docs/commands/generate-oas.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,9 @@ Usage: xano generate-oas [options]
Update and generate OpenAPI spec(s) for the current context.

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.
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
Interface.
--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.
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
--group <name> API group name. Same as on Xano Interface.
--all Regenerate for all API groups in the workspace / branch of the current context.
--print-output-dir Expose usable output path for further reuse.
Expand Down
9 changes: 3 additions & 6 deletions docs/commands/generate-repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,9 @@ Process Xano workspace into repo structure
Options:
--input <file> workspace yaml file
--output <dir> output directory (overrides config)
--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.
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
Interface.
--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.
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
--print-output-dir Expose usable output path for further reuse.
--fetch Specify this if you want to fetch the workspace schema from Xano
-h, --help display help for command
Expand Down
9 changes: 3 additions & 6 deletions docs/commands/generate-xs-repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,9 @@ Usage: xano generate-xs-repo [options]
Process Xano workspace into repo structure

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.
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
Interface.
--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.
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
--print-output-dir Expose usable output path for further reuse.
-h, --help display help for command
```
12 changes: 4 additions & 8 deletions docs/commands/registry-add.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,10 @@ Usage: xano registry-add [options]
Add a prebuilt component to the current Xano context.

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.
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
Interface.
--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.
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
--components Comma-separated list of components to add
--registry <url> URL to the component registry. Default:
http://localhost:5500/registry/definitions
--registry <url> URL to the component registry. Default: http://localhost:5500/registry/definitions
-h, --help display help for command
```
8 changes: 3 additions & 5 deletions docs/commands/registry-scaffold.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,12 @@ $ xano registry-scaffold [options]
$ xano registry-scaffold --help
Usage: xano registry-scaffold [options]

Scaffold a Xano registry folder with a sample component. Xano registry can be used to share and reuse
prebuilt components. In the registry you have to follow the
[registry](https://calycode.com/schemas/registry/registry.json) and [registry
Scaffold a Xano registry folder with a sample component. Xano registry can be used to share and reuse prebuilt components. In the registry you
have to follow the [registry](https://calycode.com/schemas/registry/registry.json) and [registry
item](https://calycode.com/schemas/registry/registry-item.json) schemas.

Options:
--output <path> Output path for the registry
--instance <instance> The instance name. This is used to fetch the instance configuration. The value
provided at the setup command.
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
-h, --help display help for command
```
6 changes: 2 additions & 4 deletions docs/commands/restore-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,8 @@ Usage: xano restore-backup [options]
Restore a backup to a Xano Workspace via Metadata API

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.
--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.
--source-backup <file> Path to the backup file to restore
--force Force restoration without confirmation
-h, --help display help for command
Expand Down
9 changes: 3 additions & 6 deletions docs/commands/run-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,9 @@ Usage: xano run-test [options]
Run an API test suite via the OpenAPI spec. WIP...

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.
--branch <branch> The branch name. This is used to select the branch configuration. Same as on
Xano Interface.
--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.
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
--group <name> API group name. Same as on Xano Interface.
--all Regenerate for all API groups in the workspace / branch of the current context.
--print-output-dir Expose usable output path for further reuse.
Expand Down
12 changes: 4 additions & 8 deletions docs/commands/serve-oas.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,12 @@ Usage: xano serve-oas [options]
Serve the Open API specification locally for quick visual check.

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.
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
Interface.
--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.
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
--group <name> API group name. Same as on Xano Interface.
--all Regenerate for all API groups in the workspace / branch of the current context.
--listen <port> The port where you want your registry to be served locally. By default it is
5000.
--listen <port> The port where you want your registry to be served locally. By default it is 5000.
--cors Do you want to enable CORS? By default false.
-h, --help display help for command
```
Loading