docs: added auto-docs site generation via the docsify.js package

MihalyToth20 · MihalyToth20 · commit d692c80f83ee · 2025-09-05T10:11:38.000+02:00
diff --git a/.changeset/rich-suns-look.md b/.changeset/rich-suns-look.md
@@ -5,3 +5,4 @@
 
 refactor: rebrand actually, renamed the core package from caly-core to core and the command from caly-xano to simply xano
 feat: added more descriptive and styled mardkown as docs that are generated from command signatures
+docs: integrated docsify.js to auto-generate documentation site from command signatures.
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,21 @@
+
+-  ### Core Commands:
+
+   -  [xano - the core command](xano.md)
+
+-  ### Features
+
+   -  [`setup`](commands/setup.md)
+   -  [`switch-context`](commands/switch-context.md)
+   -  [`generate-oas`](commands/generate-oas.md)
+   -  [`serve-oas`](commands/serve-oas.md)
+   -  [`generate-code`](commands/generate-code.md)
+   -  [`generate-repo`](commands/generate-repo.md)
+   -  [`generate-xs-repo`](commands/generate-xs-repo.md)
+   -  [`registry-add`](commands/registry-add.md)
+   -  [`registry-scaffold`](commands/registry-scaffold.md)
+   -  [`serve-registry`](commands/serve-registry.md)
+   -  [`export-backup`](commands/export-backup.md)
+   -  [`restore-backup`](commands/restore-backup.md)
+   -  [`run-test`](commands/run-test.md)
+   -  [`current-context`](commands/current-context.md)
diff --git a/docs/commands/export-backup.md b/docs/commands/export-backup.md
@@ -18,11 +18,16 @@ 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.
-  --print-output-dir       Expose usable output path for further reuse.
+  --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
 ```
diff --git a/docs/commands/generate-code.md b/docs/commands/generate-code.md
@@ -25,21 +25,32 @@
 ```sh
 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
+  --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
+  --debug                  Specify this flag in order to allow
+                           logging. Logs will appear in output/_logs.
+                           Default: false
   -h, --help               display help for command
 ```
diff --git a/docs/commands/generate-oas.md b/docs/commands/generate-oas.md
@@ -22,13 +22,19 @@ 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.
+  --all                    Regenerate for all API groups in the
+                           workspace / branch of the current context.
+  --print-output-dir       Expose usable output path for further
+                           reuse.
   -h, --help               display help for command
 ```
diff --git a/docs/commands/generate-repo.md b/docs/commands/generate-repo.md
@@ -26,12 +26,18 @@ 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.
-  --print-output-dir       Expose usable output path for further reuse.
-  --fetch                  Specify this if you want to fetch the workspace schema from Xano
+  --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
 ```
diff --git a/docs/commands/generate-xs-repo.md b/docs/commands/generate-xs-repo.md
@@ -18,11 +18,16 @@ 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.
-  --print-output-dir       Expose usable output path for further reuse.
+  --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
 ```
diff --git a/docs/commands/registry-add.md b/docs/commands/registry-add.md
@@ -20,12 +20,17 @@ 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
 ```
diff --git a/docs/commands/registry-scaffold.md b/docs/commands/registry-scaffold.md
@@ -11,13 +11,18 @@
 ```sh
 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://nextcurve.hu/schemas/registry/registry.json) and
-[registry item](https://nextcurve.hu/schemas/registry/registry-item.json) schemas.
+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://nextcurve.hu/schemas/registry/registry.json) and
+[registry
+item](https://nextcurve.hu/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
 ```
diff --git a/docs/commands/restore-backup.md b/docs/commands/restore-backup.md
@@ -18,10 +18,12 @@ 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
diff --git a/docs/commands/run-test.md b/docs/commands/run-test.md
@@ -24,14 +24,22 @@ 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.
-  --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.
+  --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.
   --test-config-path <path>  Path to a test configuration file.
   -h, --help                 display help for command
 ```
diff --git a/docs/commands/serve-oas.md b/docs/commands/serve-oas.md
@@ -24,14 +24,21 @@ 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.
-  --cors                   Do you want to enable CORS? By default false.
+  --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.
+  --cors                   Do you want to enable CORS? By default
+                           false.
   -h, --help               display help for command
 ```
diff --git a/docs/commands/serve-registry.md b/docs/commands/serve-registry.md
@@ -13,11 +13,13 @@
 ```sh
 Usage: xano serve-registry [options]
 
-Serve the registry locally. This allows you to actually use your registry without deploying it.
+Serve the registry locally. This allows you to actually use your
+registry without deploying it.
 
 Options:
   --root <path>    Where did you put your registry?
-  --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
 ```
diff --git a/docs/commands/switch-context.md b/docs/commands/switch-context.md
@@ -16,10 +16,14 @@ Usage: xano switch-context [options]
 Switch instance/workspace 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.
   -h, --help               display help for command
 ```
diff --git a/docs/index.html b/docs/index.html
diff --git a/scripts/generate-caly-cli-docs.ts b/scripts/generate-caly-cli-docs.ts
diff --git a/util-resources/docs-template/.nojekyll b/util-resources/docs-template/.nojekyll
diff --git a/util-resources/docs-template/_sidebar.md b/util-resources/docs-template/_sidebar.md
diff --git a/util-resources/docs-template/index.html b/util-resources/docs-template/index.html

Original file line number	Diff line number	Diff line change
`@@ -5,3 +5,4 @@`
`5`	`5`
`6`	`6`	`refactor: rebrand actually, renamed the core package from caly-core to core and the command from caly-xano to simply xano`
`7`	`7`	`feat: added more descriptive and styled mardkown as docs that are generated from command signatures`
	`8`	`+docs: integrated docsify.js to auto-generate documentation site from command signatures.`