diff --git a/.changeset/three-singers-rush.md b/.changeset/three-singers-rush.md new file mode 100644 index 0000000..bd73285 --- /dev/null +++ b/.changeset/three-singers-rush.md @@ -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 diff --git a/context7.json b/context7.json new file mode 100644 index 0000000..e755ffc --- /dev/null +++ b/context7.json @@ -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" + ] +} \ No newline at end of file diff --git a/docs/commands/export-backup.md b/docs/commands/export-backup.md index 92d3307..95cb1d5 100644 --- a/docs/commands/export-backup.md +++ b/docs/commands/export-backup.md @@ -24,12 +24,9 @@ Usage: xano export-backup [options] Backup Xano Workspace via Metadata API Options: - --instance The instance name. This is used to fetch the instance configuration. The value - provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace configuration. Same as on - Xano interface. - --branch The branch name. This is used to select the branch configuration. Same as on Xano - Interface. + --instance The instance name. This is used to fetch the instance configuration. The value provided at the setup command. + --workspace The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface. + --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 ``` \ No newline at end of file diff --git a/docs/commands/generate-code.md b/docs/commands/generate-code.md index 7bbd441..c426bdc 100644 --- a/docs/commands/generate-code.md +++ b/docs/commands/generate-code.md @@ -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 The instance name. This is used to fetch the instance configuration. The value - provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace configuration. Same as on - Xano interface. - --branch The branch name. This is used to select the branch configuration. Same as on Xano - Interface. + --instance The instance name. This is used to fetch the instance configuration. The value provided at the setup command. + --workspace The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface. + --branch The branch name. This is used to select the branch configuration. Same as on Xano Interface. --group 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 to use, see all options at: - https://openapi-generator.tech/docs/generators - --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 to use, see all options at: https://openapi-generator.tech/docs/generators + --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 ``` \ No newline at end of file diff --git a/docs/commands/generate-oas.md b/docs/commands/generate-oas.md index 6140989..317c6a2 100644 --- a/docs/commands/generate-oas.md +++ b/docs/commands/generate-oas.md @@ -28,12 +28,9 @@ Usage: xano generate-oas [options] Update and generate OpenAPI spec(s) for the current context. Options: - --instance The instance name. This is used to fetch the instance configuration. The value - provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace configuration. Same as on - Xano interface. - --branch The branch name. This is used to select the branch configuration. Same as on Xano - Interface. + --instance The instance name. This is used to fetch the instance configuration. The value provided at the setup command. + --workspace The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface. + --branch The branch name. This is used to select the branch configuration. Same as on Xano Interface. --group 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. diff --git a/docs/commands/generate-repo.md b/docs/commands/generate-repo.md index d5f0b94..7534fca 100644 --- a/docs/commands/generate-repo.md +++ b/docs/commands/generate-repo.md @@ -32,12 +32,9 @@ Process Xano workspace into repo structure Options: --input workspace yaml file --output output directory (overrides config) - --instance The instance name. This is used to fetch the instance configuration. The value - provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace configuration. Same as on - Xano interface. - --branch The branch name. This is used to select the branch configuration. Same as on Xano - Interface. + --instance The instance name. This is used to fetch the instance configuration. The value provided at the setup command. + --workspace The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface. + --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 diff --git a/docs/commands/generate-xs-repo.md b/docs/commands/generate-xs-repo.md index 4a5f4a6..d078745 100644 --- a/docs/commands/generate-xs-repo.md +++ b/docs/commands/generate-xs-repo.md @@ -24,12 +24,9 @@ Usage: xano generate-xs-repo [options] Process Xano workspace into repo structure Options: - --instance The instance name. This is used to fetch the instance configuration. The value - provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace configuration. Same as on - Xano interface. - --branch The branch name. This is used to select the branch configuration. Same as on Xano - Interface. + --instance The instance name. This is used to fetch the instance configuration. The value provided at the setup command. + --workspace The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface. + --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 ``` \ No newline at end of file diff --git a/docs/commands/registry-add.md b/docs/commands/registry-add.md index 197d566..998cb5d 100644 --- a/docs/commands/registry-add.md +++ b/docs/commands/registry-add.md @@ -26,14 +26,10 @@ Usage: xano registry-add [options] Add a prebuilt component to the current Xano context. Options: - --instance The instance name. This is used to fetch the instance configuration. The value - provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace configuration. Same as on - Xano interface. - --branch The branch name. This is used to select the branch configuration. Same as on Xano - Interface. + --instance The instance name. This is used to fetch the instance configuration. The value provided at the setup command. + --workspace The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface. + --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 to the component registry. Default: - http://localhost:5500/registry/definitions + --registry URL to the component registry. Default: http://localhost:5500/registry/definitions -h, --help display help for command ``` \ No newline at end of file diff --git a/docs/commands/registry-scaffold.md b/docs/commands/registry-scaffold.md index 79b011b..dbf65ac 100644 --- a/docs/commands/registry-scaffold.md +++ b/docs/commands/registry-scaffold.md @@ -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 Output path for the registry - --instance The instance name. This is used to fetch the instance configuration. The value - provided at the setup command. + --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 ``` \ No newline at end of file diff --git a/docs/commands/restore-backup.md b/docs/commands/restore-backup.md index 8d6d9d2..6f8f41d 100644 --- a/docs/commands/restore-backup.md +++ b/docs/commands/restore-backup.md @@ -24,10 +24,8 @@ Usage: xano restore-backup [options] Restore a backup to a Xano Workspace via Metadata API Options: - --instance The instance name. This is used to fetch the instance configuration. The value - provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace configuration. Same as on - Xano interface. + --instance The instance name. This is used to fetch the instance configuration. The value provided at the setup command. + --workspace The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface. --source-backup Path to the backup file to restore --force Force restoration without confirmation -h, --help display help for command diff --git a/docs/commands/run-test.md b/docs/commands/run-test.md index 1c2e402..8230ef0 100644 --- a/docs/commands/run-test.md +++ b/docs/commands/run-test.md @@ -30,12 +30,9 @@ Usage: xano run-test [options] Run an API test suite via the OpenAPI spec. WIP... Options: - --instance The instance name. This is used to fetch the instance configuration. The value - provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace configuration. Same as - on Xano interface. - --branch The branch name. This is used to select the branch configuration. Same as on - Xano Interface. + --instance The instance name. This is used to fetch the instance configuration. The value provided at the setup command. + --workspace The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface. + --branch The branch name. This is used to select the branch configuration. Same as on Xano Interface. --group 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. diff --git a/docs/commands/serve-oas.md b/docs/commands/serve-oas.md index c8c3629..d0ab3fe 100644 --- a/docs/commands/serve-oas.md +++ b/docs/commands/serve-oas.md @@ -30,16 +30,12 @@ Usage: xano serve-oas [options] Serve the Open API specification locally for quick visual check. Options: - --instance The instance name. This is used to fetch the instance configuration. The value - provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace configuration. Same as on - Xano interface. - --branch The branch name. This is used to select the branch configuration. Same as on Xano - Interface. + --instance The instance name. This is used to fetch the instance configuration. The value provided at the setup command. + --workspace The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface. + --branch The branch name. This is used to select the branch configuration. Same as on Xano Interface. --group API group name. Same as on Xano Interface. --all Regenerate for all API groups in the workspace / branch of the current context. - --listen The port where you want your registry to be served locally. By default it is - 5000. + --listen 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 ``` \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index f851c16..7d3d9e9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -259,6 +259,202 @@ + + + + + + + +