chore: update docs [skip ci]

github-actions[bot] · github-actions[bot] · commit ff490eae2927 · 2025-09-13T04:53:04.000Z
diff --git a/docs/README.md b/docs/README.md
@@ -141,8 +141,7 @@ I have been astonished by the shadcn/ui CLI and the core principles of code dist
 -  [x] **Scaffolding a registry** of reusable Xano components
 -  [x] Exporting all available `xanoscript` from your instance via metadata API _*(important note: not all pieces of logic can be exported via metadata API, this especially is fragile on older and bigger instances)_.
 -  [x] Adding components to Xano from a registry (only functions, tables, queries for now)
--  [ ] Automated test runner with assertion configuration
--  [ ] Linting with custom rulesets
+-  [x] Automated test runner with assertion configuration
 
 ---
 
diff --git a/docs/commands/export-backup.md b/docs/commands/export-backup.md
@@ -23,9 +23,10 @@ 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.
+                           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.
diff --git a/docs/commands/generate-code.md b/docs/commands/generate-code.md
@@ -29,25 +29,27 @@ xano generate-code [options]
 ```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.
+                           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.
+  --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
@@ -27,14 +27,15 @@ 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.
+                           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.
+  --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
@@ -31,12 +31,14 @@ 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.
+                           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
+  --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
@@ -23,9 +23,10 @@ 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.
+                           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.
diff --git a/docs/commands/registry-add.md b/docs/commands/registry-add.md
@@ -25,9 +25,10 @@ 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.
+                           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
diff --git a/docs/commands/registry-scaffold.md b/docs/commands/registry-scaffold.md
@@ -15,10 +15,11 @@ xano registry-scaffold [options]
 ```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
diff --git a/docs/commands/restore-backup.md b/docs/commands/restore-backup.md
@@ -23,9 +23,10 @@ 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.
+                           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
@@ -28,15 +28,16 @@ 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.
+  --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.
+  --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
@@ -29,16 +29,17 @@ 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.
+                           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.
+  --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
@@ -17,13 +17,13 @@ xano serve-registry [options]
 ```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
@@ -21,9 +21,10 @@ 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.
+                           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
