feat: added a little bit more styled markdown docs based on the cmd signatures from commander

Author: MihalyToth20

docs/README.md

@@ -1,24 +1,25 @@
-# @calycode/cli Command Reference
+# @calycode/cli (Caly-Xano CLI) Command Reference
 
 Supercharge your Xano workflow: automate backups, docs, testing, and version control—no AI guesswork, just reliable, transparent dev tools.
 
 ## Table of Contents
 
-- [xano - the core commmand](xano.md)
-#### Commands:
-- [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)
+- [xano - the core command](xano.md)
 
-Need further help? Visit https://github.com/calycode/xano-tools or reach out to Mihály Tóth on [State Change](https://statechange.ai/) or [Snappy Community](https://www.skool.com/@mihaly-toth-2040?g=snappy)
+### Commands
+- [`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)
+
+Need further help? Visit [GitHub](https://github.com/calycode/xano-tools) or reach out to Mihály Tóth on [State Change](https://statechange.ai/) or [Snappy Community](https://www.skool.com/@mihaly-toth-2040?g=snappy)

docs/commands/current-context.md

@@ -1,4 +1,9 @@
-```
+# `current-context` Command
+### Options
+
+
+### current-context --help
+```sh
 Usage: xano current-context [options]
 
 Options:

docs/commands/export-backup.md

@@ -1,15 +1,28 @@
-```
+# `export-backup` Command
+> Backup Xano Workspace via Metadata API
+### Options
+
+#### --instance <instance>
+**Description:** The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
+#### --workspace <workspace>
+**Description:** The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
+#### --branch <branch>
+**Description:** The branch name. This is used to select the branch configuration. Same as on Xano Interface.
+#### --print-output-dir
+**Description:** Expose usable output path for further reuse.
+
+### export-backup --help
+```sh
 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
 ```

docs/commands/generate-code.md

@@ -1,24 +1,45 @@
-```
+# `generate-code` Command
+> 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>
+**Description:** The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
+#### --workspace <workspace>
+**Description:** The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
+#### --branch <branch>
+**Description:** The branch name. This is used to select the branch configuration. Same as on Xano Interface.
+#### --group <name>
+**Description:** API group name. Same as on Xano Interface.
+#### --all
+**Description:** Regenerate for all API groups in the workspace / branch of the current context.
+#### --print-output-dir
+**Description:** Expose usable output path for further reuse.
+#### --generator <generator>
+**Description:** Generator to use, see all options at: https://openapi-generator.tech/docs/generators
+#### --args <args>
+**Description:** Additional arguments to pass to the generator. See https://openapi-generator.tech/docs/usage#generate
+#### --debug
+**Description:** Specify this flag in order to allow logging. Logs will appear in output/_logs. Default: false
+
+### generate-code --help
+```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
+  --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
 ```

docs/commands/generate-oas.md

@@ -1,15 +1,32 @@
-```
+# `generate-oas` Command
+> Update and generate OpenAPI spec(s) for the current context.
+### Options
+
+#### --instance <instance>
+**Description:** The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
+#### --workspace <workspace>
+**Description:** The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
+#### --branch <branch>
+**Description:** The branch name. This is used to select the branch configuration. Same as on Xano Interface.
+#### --group <name>
+**Description:** API group name. Same as on Xano Interface.
+#### --all
+**Description:** Regenerate for all API groups in the workspace / branch of the current context.
+#### --print-output-dir
+**Description:** Expose usable output path for further reuse.
+
+### generate-oas --help
+```sh
 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.

docs/commands/generate-repo.md

@@ -1,17 +1,36 @@
-```
+# `generate-repo` Command
+> Process Xano workspace into repo structure
+### Options
+
+#### --input <file>
+**Description:** workspace yaml file
+#### --output <dir>
+**Description:** output directory (overrides config)
+#### --instance <instance>
+**Description:** The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
+#### --workspace <workspace>
+**Description:** The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
+#### --branch <branch>
+**Description:** The branch name. This is used to select the branch configuration. Same as on Xano Interface.
+#### --print-output-dir
+**Description:** Expose usable output path for further reuse.
+#### --fetch
+**Description:** Specify this if you want to fetch the workspace schema from Xano
+
+### generate-repo --help
+```sh
 Usage: xano generate-repo [options]
 
 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

docs/commands/generate-xs-repo.md

@@ -1,15 +1,28 @@
-```
+# `generate-xs-repo` Command
+> Process Xano workspace into repo structure
+### Options
+
+#### --instance <instance>
+**Description:** The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
+#### --workspace <workspace>
+**Description:** The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
+#### --branch <branch>
+**Description:** The branch name. This is used to select the branch configuration. Same as on Xano Interface.
+#### --print-output-dir
+**Description:** Expose usable output path for further reuse.
+
+### generate-xs-repo --help
+```sh
 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
 ```

docs/commands/registry-add.md

@@ -1,17 +1,31 @@
-```
+# `registry-add` Command
+> Add a prebuilt component to the current Xano context.
+### Options
+
+#### --instance <instance>
+**Description:** The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
+#### --workspace <workspace>
+**Description:** The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
+#### --branch <branch>
+**Description:** The branch name. This is used to select the branch configuration. Same as on Xano Interface.
+#### --components
+**Description:** Comma-separated list of components to add
+#### --registry <url>
+**Description:** URL to the component registry. Default: http://localhost:5500/registry/definitions
+
+### registry-add --help
+```sh
 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
 ```

docs/commands/registry-scaffold.md

@@ -1,14 +1,23 @@
-```
+# `registry-scaffold` Command
+> 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>
+**Description:** Output path for the registry
+#### --instance <instance>
+**Description:** The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
+
+### registry-scaffold --help
+```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
 ```

docs/commands/restore-backup.md

@@ -1,13 +1,27 @@
-```
+# `restore-backup` Command
+> Restore a backup to a Xano Workspace via Metadata API
+### Options
+
+#### --instance <instance>
+**Description:** The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
+#### --workspace <workspace>
+**Description:** The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
+#### --source-backup <file>
+**Description:** Path to the backup file to restore
+#### --force
+**Description:** Force restoration without confirmation
+
+### restore-backup --help
+```sh
 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