Release Version (#146)

MihalyToth20 · web-flow · commit cbc872582745 · 2025-10-22T21:55:55.000+02:00
diff --git a/.changeset/calm-sheep-rest.md b/.changeset/calm-sheep-rest.md
diff --git a/.changeset/fuzzy-bushes-battle.md b/.changeset/fuzzy-bushes-battle.md
diff --git a/docs/commands/generate-code.md b/docs/commands/generate-code.md
@@ -22,7 +22,7 @@ $ xano generate-code [options]
 #### --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
+**Description:** Additional arguments to pass to the generator. For options for each 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
 
@@ -49,7 +49,8 @@ Options:
   --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
+  --args <args>            Additional arguments to pass to the generator. For
+                           options for each 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
diff --git a/docs/commands/generate-oas.md b/docs/commands/generate-oas.md
@@ -1,6 +1,6 @@
 # generate-oas
 >[!NOTE|label:Description]
-> #### Update and generate OpenAPI spec(s) for the current context.
+> #### Update and generate OpenAPI spec(s) for the current context, or all API groups simultaneously. This generates an opinionated API documentation powered by Scalar API Reference. + this command brings the Swagger docs to OAS 3.1+ version.
 
 ```term
 $ xano generate-oas [options]
@@ -25,7 +25,10 @@ $ xano generate-oas [options]
 $ xano generate-oas --help
 Usage: xano generate-oas [options]
 
-Update and generate OpenAPI spec(s) for the current context.
+Update and generate OpenAPI spec(s) for the current context, or all API groups
+simultaneously. This generates an opinionated API documentation powered by
+Scalar API Reference. + this command brings the Swagger docs to OAS 3.1+
+version.
 
 Options:
   --instance <instance>    The instance name. This is used to fetch the instance
diff --git a/docs/commands/generate-repo.md b/docs/commands/generate-repo.md
@@ -1,16 +1,16 @@
 # generate-repo
 >[!NOTE|label:Description]
-> #### Process Xano workspace into repo structure
+> #### Process Xano workspace into repo structure. We use the export-schema metadata API to offer the full details. However that is enriched with the Xanoscripts after Xano 2.0 release.
 
 ```term
 $ xano generate-repo [options]
 ```
 ### Options
 
-#### --input <file>
-**Description:** workspace yaml file
-#### --output <dir>
-**Description:** output directory (overrides config)
+#### -I, --input <file>
+**Description:** Workspace yaml file from a local source, if present.
+#### -O, --output <dir>
+**Description:** Output directory (overrides default config), useful when ran from a CI/CD pipeline and want to ensure consistent output location.
 #### --instance <instance>
 **Description:** The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
 #### --workspace <workspace>
@@ -19,19 +19,23 @@ $ xano generate-repo [options]
 **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
+#### -F, --fetch
+**Description:** Forces fetching the workspace schema from the Xano instance via metadata API.
 
 ### generate-repo --help
 ```term
 $ xano generate-repo --help
 Usage: xano generate-repo [options]
 
-Process Xano workspace into repo structure
+Process Xano workspace into repo structure. We use the export-schema metadata
+API to offer the full details. However that is enriched with the Xanoscripts
+after Xano 2.0 release.
 
 Options:
-  --input <file>           workspace yaml file
-  --output <dir>           output directory (overrides config)
+  -I, --input <file>       Workspace yaml file from a local source, if present.
+  -O, --output <dir>       Output directory (overrides default config), useful
+                           when ran from a CI/CD pipeline and want to ensure
+                           consistent output location.
   --instance <instance>    The instance name. This is used to fetch the instance
                            configuration. The value provided at the setup
                            command.
@@ -40,7 +44,7 @@ Options:
   --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
+  -F, --fetch              Forces fetching the workspace schema from the Xano
+                           instance via metadata API.
   -h, --help               display help for command
 ```
diff --git a/docs/commands/generate-xs-repo.md b/docs/commands/generate-xs-repo.md
@@ -1,6 +1,6 @@
 # generate-xs-repo
 >[!NOTE|label:Description]
-> #### Process Xano workspace into repo structure
+> #### Process Xano workspace into repo structure. Supports table, function and apis as of know. Xano VSCode extension is the preferred solution over this command. Outputs of this process are also included in the default repo generation command.
 
 ```term
 $ xano generate-xs-repo [options]
@@ -21,7 +21,10 @@ $ xano generate-xs-repo [options]
 $ xano generate-xs-repo --help
 Usage: xano generate-xs-repo [options]
 
-Process Xano workspace into repo structure
+Process Xano workspace into repo structure. Supports table, function and apis as
+of know. Xano VSCode extension is the preferred solution over this command.
+Outputs of this process are also included in the default repo generation
+command.
 
 Options:
   --instance <instance>    The instance name. This is used to fetch the instance
diff --git a/docs/commands/registry-add.md b/docs/commands/registry-add.md
@@ -1,6 +1,6 @@
 # registry-add
 >[!NOTE|label:Description]
-> #### Add a prebuilt component to the current Xano context.
+> #### Add a prebuilt component to the current Xano context, essentially by pushing an item from the registry to the Xano instance.
 
 ```term
 $ xano registry-add [options]
@@ -23,7 +23,8 @@ $ xano registry-add [options]
 $ xano registry-add --help
 Usage: xano registry-add [options]
 
-Add a prebuilt component to the current Xano context.
+Add a prebuilt component to the current Xano context, essentially by pushing an
+item from the registry to the Xano instance.
 
 Options:
   --instance <instance>    The instance name. This is used to fetch the instance
diff --git a/docs/commands/registry-scaffold.md b/docs/commands/registry-scaffold.md
@@ -8,7 +8,7 @@ $ xano registry-scaffold [options]
 ### Options
 
 #### --output <path>
-**Description:** Output path for the registry
+**Description:** Local 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.
 
@@ -24,7 +24,7 @@ the [registry](https://calycode.com/schemas/registry/registry.json) and
 schemas.
 
 Options:
-  --output <path>        Output path for the registry
+  --output <path>        Local 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.
   -h, --help             display help for command
diff --git a/docs/commands/restore-backup.md b/docs/commands/restore-backup.md
@@ -1,6 +1,6 @@
 # restore-backup
 >[!NOTE|label:Description]
-> #### Restore a backup to a Xano Workspace via Metadata API
+> #### Restore a backup to a Xano Workspace via Metadata API. DANGER! This action will override all business logic and restore the original v1 branch. Data will be also restored from the backup file.
 
 ```term
 $ xano restore-backup [options]
@@ -11,25 +11,30 @@ $ xano restore-backup [options]
 **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
+#### -S, --source-backup <file>
+**Description:** Local path to the backup file to restore.
 #### --force
-**Description:** Force restoration without confirmation
+**Description:** Force restoration without confirmation, not advised to be specified, useful when ran from a CI/CD pipeline and consequences are acknowledged.
 
 ### restore-backup --help
 ```term
 $ xano restore-backup --help
 Usage: xano restore-backup [options]
 
-Restore a backup to a Xano Workspace via Metadata API
+Restore a backup to a Xano Workspace via Metadata API. DANGER! This action will
+override all business logic and restore the original v1 branch. Data will be
+also restored from the backup file.
 
 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.
-  --source-backup <file>   Path to the backup file to restore
-  --force                  Force restoration without confirmation
-  -h, --help               display help for command
+  --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.
+  -S, --source-backup <file>  Local path to the backup file to restore.
+  --force                     Force restoration without confirmation, not
+                              advised to be specified, useful when ran from a
+                              CI/CD pipeline and consequences are acknowledged.
+  -h, --help                  display help for command
 ```
diff --git a/docs/commands/run-test.md b/docs/commands/run-test.md
@@ -1,6 +1,6 @@
 # run-test
 >[!NOTE|label:Description]
-> #### Run an API test suite via the OpenAPI spec. WIP...
+> #### Run an API test suite via the OpenAPI spec. To execute this command a specification is required. Find the schema here: https://calycode.com/schemas/testing/config.json 
 
 ```term
 $ xano run-test [options]
@@ -20,14 +20,16 @@ $ xano run-test [options]
 #### --print-output-dir
 **Description:** Expose usable output path for further reuse.
 #### --test-config-path <path>
-**Description:** Path to a test configuration file.
+**Description:** Local path to the test configuration file.
 
 ### run-test --help
 ```term
 $ xano run-test --help
 Usage: xano run-test [options]
 
-Run an API test suite via the OpenAPI spec. WIP...
+Run an API test suite via the OpenAPI spec. To execute this command a
+specification is required. Find the schema here:
+https://calycode.com/schemas/testing/config.json
 
 Options:
   --instance <instance>      The instance name. This is used to fetch the
@@ -41,6 +43,6 @@ Options:
   --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.
+  --test-config-path <path>  Local path to the test configuration file.
   -h, --help                 display help for command
 ```
diff --git a/docs/commands/serve-oas.md b/docs/commands/serve-oas.md
@@ -1,6 +1,6 @@
 # serve-oas
 >[!NOTE|label:Description]
-> #### Serve the Open API specification locally for quick visual check.
+> #### Serve the Open API specification locally for quick visual check, or to test your APIs via the Scalar API reference.
 
 ```term
 $ xano serve-oas [options]
@@ -27,7 +27,8 @@ $ xano serve-oas [options]
 $ xano serve-oas --help
 Usage: xano serve-oas [options]
 
-Serve the Open API specification locally for quick visual check.
+Serve the Open API specification locally for quick visual check, or to test your
+APIs via the Scalar API reference.
 
 Options:
   --instance <instance>    The instance name. This is used to fetch the instance
diff --git a/docs/commands/serve-registry.md b/docs/commands/serve-registry.md
@@ -1,14 +1,14 @@
 # serve-registry
 >[!NOTE|label:Description]
-> #### 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 to any remote host.
 
 ```term
 $ xano serve-registry [options]
 ```
 ### Options
 
 #### --root <path>
-**Description:** Where did you put your registry?
+**Description:** Where did you put your registry? (Local path to the registry directory)
 #### --listen <port>
 **Description:** The port where you want your registry to be served locally. By default it is 5000.
 #### --cors
@@ -20,10 +20,11 @@ $ xano serve-registry --help
 Usage: xano serve-registry [options]
 
 Serve the registry locally. This allows you to actually use your registry
-without deploying it.
+without deploying it to any remote host.
 
 Options:
-  --root <path>    Where did you put your registry?
+  --root <path>    Where did you put your registry? (Local path to the registry
+                   directory)
   --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.
diff --git a/docs/commands/setup.md b/docs/commands/setup.md
@@ -1,6 +1,6 @@
 # setup
 >[!NOTE|label:Description]
-> #### Setup Xano instance configurations (interactively or via flags)
+> #### Setup Xano instance configurations (interactively or via flags), this enables the CLI to know about context, APIs and in general this is required for any command to succeed.
 
 ```term
 $ xano setup [options]
@@ -14,19 +14,22 @@ $ xano setup [options]
 #### --token <token>
 **Description:** Metadata API token (for non-interactive setup)
 #### --no-set-current
-**Description:** Do not set this instance as the current context
+**Description:** Flag to not set this instance as the current context, by default it is set.
 
 ### setup --help
 ```term
 $ xano setup --help
 Usage: xano setup [options]
 
-Setup Xano instance configurations (interactively or via flags)
+Setup Xano instance configurations (interactively or via flags), this enables
+the CLI to know about context, APIs and in general this is required for any
+command to succeed.
 
 Options:
   --name <name>     Instance name (for non-interactive setup)
   --url <url>       Instance base URL (for non-interactive setup)
   --token <token>   Metadata API token (for non-interactive setup)
-  --no-set-current  Do not set this instance as the current context
+  --no-set-current  Flag to not set this instance as the current context, by
+                    default it is set.
   -h, --help        display help for command
 ```
diff --git a/docs/xano.md b/docs/xano.md
@@ -26,26 +26,26 @@ Options:
 
 Core Commands:
   setup              -h, --help
-    Setup Xano instance configurations (interactively or via flags)
+    Setup Xano instance configurations (interactively or via flags), this enables the CLI to know about context, APIs and in general this is required for any command to succeed.
 
 
 Code Generation:
   generate-oas       -h, --help
-    Update and generate OpenAPI spec(s) for the current context.
+    Update and generate OpenAPI spec(s) for the current context, or all API groups simultaneously. This generates an opinionated API documentation powered by Scalar API Reference. + this command brings the Swagger docs to OAS 3.1+ version.
 
   generate-code      -h, --help
     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.
 
   generate-repo      -h, --help
-    Process Xano workspace into repo structure
+    Process Xano workspace into repo structure. We use the export-schema metadata API to offer the full details. However that is enriched with the Xanoscripts after Xano 2.0 release.
 
   generate-xs-repo   -h, --help
-    Process Xano workspace into repo structure
+    Process Xano workspace into repo structure. Supports table, function and apis as of know. Xano VSCode extension is the preferred solution over this command. Outputs of this process are also included in the default repo generation command.
 
 
 Registry:
   registry-add       -h, --help
-    Add a prebuilt component to the current Xano context.
+    Add a prebuilt component to the current Xano context, essentially by pushing an item from the registry to the Xano instance.
 
   registry-scaffold  -h, --help
     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.
@@ -56,12 +56,12 @@ Backup & Restore:
     Backup Xano Workspace via Metadata API
 
   restore-backup     -h, --help
-    Restore a backup to a Xano Workspace via Metadata API
+    Restore a backup to a Xano Workspace via Metadata API. DANGER! This action will override all business logic and restore the original v1 branch. Data will be also restored from the backup file.
 
 
 Testing & Linting:
   run-test           -h, --help
-    Run an API test suite via the OpenAPI spec. WIP...
+    Run an API test suite via the OpenAPI spec. To execute this command a specification is required. Find the schema here: https://calycode.com/schemas/testing/config.json 
 
 
 Other:
diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
diff --git a/packages/cli/package.json b/packages/cli/package.json
diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md
diff --git a/packages/core/package.json b/packages/core/package.json
