Skip to content

Commit ec1fa15

Browse files
committed
chore: added context7.json for configuration, added copy-page button to the docs (mintlify-style)
1 parent 670ffbc commit ec1fa15

File tree

13 files changed

+447
-69
lines changed

13 files changed

+447
-69
lines changed

context7.json

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"$schema": "https://context7.com/schema/context7.json",
3+
"projectTitle": "@calycode/cli",
4+
"description": "Community-driven CLI tool for Xano Backend, to automate documentation generation, version control, testing and so much more.",
5+
"branch": "main",
6+
"excludeFolders": [
7+
"scripts",
8+
"util-resources",
9+
".github",
10+
".changeset",
11+
"packages/**/src",
12+
"packages/**/__tests__"
13+
],
14+
"excludeFiles": [],
15+
"rules": [
16+
"Use when required to run commands to backup a xano workspace",
17+
"Use when extracting xanoscript from Xano workspace",
18+
"Use when generating improved OpenAPI specification from Xano workspace",
19+
"Use when needed to generate client side code for a Xano backend"
20+
]
21+
}

docs/commands/export-backup.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,9 @@ Usage: xano export-backup [options]
2424
Backup Xano Workspace via Metadata API
2525
2626
Options:
27-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value
28-
provided at the setup command.
29-
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on
30-
Xano interface.
31-
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
32-
Interface.
27+
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
28+
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
29+
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
3330
--print-output-dir Expose usable output path for further reuse.
3431
-h, --help display help for command
3532
```

docs/commands/generate-code.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -31,24 +31,17 @@ $ xano generate-code [options]
3131
$ xano generate-code --help
3232
Usage: xano generate-code [options]
3333
34-
Create a library based on the OpenAPI specification. If the openapi specification has not yet been
35-
generated, this will generate that as well as the first step.
34+
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.
3635
3736
Options:
38-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value
39-
provided at the setup command.
40-
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on
41-
Xano interface.
42-
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
43-
Interface.
37+
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
38+
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
39+
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
4440
--group <name> API group name. Same as on Xano Interface.
4541
--all Regenerate for all API groups in the workspace / branch of the current context.
4642
--print-output-dir Expose usable output path for further reuse.
47-
--generator <generator> Generator to use, see all options at:
48-
https://openapi-generator.tech/docs/generators
49-
--args <args> Additional arguments to pass to the generator. See
50-
https://openapi-generator.tech/docs/usage#generate
51-
--debug Specify this flag in order to allow logging. Logs will appear in output/_logs.
52-
Default: false
43+
--generator <generator> Generator to use, see all options at: https://openapi-generator.tech/docs/generators
44+
--args <args> Additional arguments to pass to the generator. See https://openapi-generator.tech/docs/usage#generate
45+
--debug Specify this flag in order to allow logging. Logs will appear in output/_logs. Default: false
5346
-h, --help display help for command
5447
```

docs/commands/generate-oas.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,9 @@ Usage: xano generate-oas [options]
2828
Update and generate OpenAPI spec(s) for the current context.
2929
3030
Options:
31-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value
32-
provided at the setup command.
33-
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on
34-
Xano interface.
35-
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
36-
Interface.
31+
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
32+
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
33+
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
3734
--group <name> API group name. Same as on Xano Interface.
3835
--all Regenerate for all API groups in the workspace / branch of the current context.
3936
--print-output-dir Expose usable output path for further reuse.

docs/commands/generate-repo.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,9 @@ Process Xano workspace into repo structure
3232
Options:
3333
--input <file> workspace yaml file
3434
--output <dir> output directory (overrides config)
35-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value
36-
provided at the setup command.
37-
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on
38-
Xano interface.
39-
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
40-
Interface.
35+
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
36+
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
37+
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
4138
--print-output-dir Expose usable output path for further reuse.
4239
--fetch Specify this if you want to fetch the workspace schema from Xano
4340
-h, --help display help for command

docs/commands/generate-xs-repo.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,9 @@ Usage: xano generate-xs-repo [options]
2424
Process Xano workspace into repo structure
2525
2626
Options:
27-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value
28-
provided at the setup command.
29-
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on
30-
Xano interface.
31-
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
32-
Interface.
27+
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
28+
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
29+
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
3330
--print-output-dir Expose usable output path for further reuse.
3431
-h, --help display help for command
3532
```

docs/commands/registry-add.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,10 @@ Usage: xano registry-add [options]
2626
Add a prebuilt component to the current Xano context.
2727
2828
Options:
29-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value
30-
provided at the setup command.
31-
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on
32-
Xano interface.
33-
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
34-
Interface.
29+
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
30+
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
31+
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
3532
--components Comma-separated list of components to add
36-
--registry <url> URL to the component registry. Default:
37-
http://localhost:5500/registry/definitions
33+
--registry <url> URL to the component registry. Default: http://localhost:5500/registry/definitions
3834
-h, --help display help for command
3935
```

docs/commands/registry-scaffold.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,11 @@ $ xano registry-scaffold [options]
1717
$ xano registry-scaffold --help
1818
Usage: xano registry-scaffold [options]
1919
20-
Scaffold a Xano registry folder with a sample component. Xano registry can be used to share and reuse
21-
prebuilt components. In the registry you have to follow the
22-
[registry](https://calycode.com/schemas/registry/registry.json) and [registry
20+
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
2321
item](https://calycode.com/schemas/registry/registry-item.json) schemas.
2422
2523
Options:
2624
--output <path> Output path for the registry
27-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value
28-
provided at the setup command.
25+
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
2926
-h, --help display help for command
3027
```

docs/commands/restore-backup.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,8 @@ Usage: xano restore-backup [options]
2424
Restore a backup to a Xano Workspace via Metadata API
2525
2626
Options:
27-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value
28-
provided at the setup command.
29-
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on
30-
Xano interface.
27+
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
28+
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
3129
--source-backup <file> Path to the backup file to restore
3230
--force Force restoration without confirmation
3331
-h, --help display help for command

docs/commands/run-test.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,9 @@ Usage: xano run-test [options]
3030
Run an API test suite via the OpenAPI spec. WIP...
3131
3232
Options:
33-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value
34-
provided at the setup command.
35-
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as
36-
on Xano interface.
37-
--branch <branch> The branch name. This is used to select the branch configuration. Same as on
38-
Xano Interface.
33+
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
34+
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
35+
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
3936
--group <name> API group name. Same as on Xano Interface.
4037
--all Regenerate for all API groups in the workspace / branch of the current context.
4138
--print-output-dir Expose usable output path for further reuse.

0 commit comments

Comments
 (0)