From a78d89fc567a731f45df500e78d85c007128a003 Mon Sep 17 00:00:00 2001
From: asyncapi-bot <bot+chan@asyncapi.io>
Date: Wed, 6 Mar 2024 14:05:57 +0100
Subject: [PATCH] docs(cli): update latest cli documentation (#2744)

---
 pages/docs/tools/cli/usage.md | 188 +++++++++++++++++-----------------
 1 file changed, 96 insertions(+), 92 deletions(-)

diff --git a/pages/docs/tools/cli/usage.md b/pages/docs/tools/cli/usage.md
index 9405bfc878c1..c31c3d90ced5 100644
--- a/pages/docs/tools/cli/usage.md
+++ b/pages/docs/tools/cli/usage.md
@@ -29,7 +29,7 @@ $ npm install -g @asyncapi/cli
 $ asyncapi COMMAND
 running command...
 $ asyncapi (--version)
-@asyncapi/cli/1.5.16 linux-x64 node-v18.19.1
+@asyncapi/cli/1.5.17 linux-x64 node-v18.19.1
 $ asyncapi --help [COMMAND]
 USAGE
   $ asyncapi COMMAND
@@ -93,7 +93,7 @@ EXAMPLES
   $ asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./asyncapi.yaml --reference-into-components
 ```
 
-_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/bundle.ts)_
+_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/bundle.ts)_
 
 ## `asyncapi config`
 
@@ -107,7 +107,7 @@ DESCRIPTION
   CLI config settings
 ```
 
-_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/config/index.ts)_
+_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/config/index.ts)_
 
 ## `asyncapi config context`
 
@@ -121,7 +121,7 @@ DESCRIPTION
   Manage short aliases for full paths to AsyncAPI documents
 ```
 
-_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/config/context/index.ts)_
+_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/config/context/index.ts)_
 
 ## `asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`
 
@@ -143,7 +143,7 @@ DESCRIPTION
   Add a context to the store
 ```
 
-_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/config/context/add.ts)_
+_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/config/context/add.ts)_
 
 ## `asyncapi config context current`
 
@@ -160,7 +160,7 @@ DESCRIPTION
   Shows the current context that is being used
 ```
 
-_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/config/context/current.ts)_
+_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/config/context/current.ts)_
 
 ## `asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`
 
@@ -181,7 +181,7 @@ DESCRIPTION
   Edit a context in the store
 ```
 
-_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/config/context/edit.ts)_
+_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/config/context/edit.ts)_
 
 ## `asyncapi config context init [CONTEXT-FILE-PATH]`
 
@@ -204,7 +204,7 @@ DESCRIPTION
   Initialize context
 ```
 
-_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/config/context/init.ts)_
+_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/config/context/init.ts)_
 
 ## `asyncapi config context list`
 
@@ -221,7 +221,7 @@ DESCRIPTION
   List all the stored contexts in the store
 ```
 
-_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/config/context/list.ts)_
+_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/config/context/list.ts)_
 
 ## `asyncapi config context remove CONTEXT-NAME`
 
@@ -241,7 +241,7 @@ DESCRIPTION
   Delete a context from the store
 ```
 
-_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/config/context/remove.ts)_
+_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/config/context/remove.ts)_
 
 ## `asyncapi config context use CONTEXT-NAME`
 
@@ -261,7 +261,7 @@ DESCRIPTION
   Set a context as current
 ```
 
-_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/config/context/use.ts)_
+_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/config/context/use.ts)_
 
 ## `asyncapi config versions`
 
@@ -278,7 +278,7 @@ DESCRIPTION
   Show versions of AsyncAPI tools used
 ```
 
-_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/config/versions.ts)_
+_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/config/versions.ts)_
 
 ## `asyncapi convert [SPEC-FILE]`
 
@@ -300,7 +300,7 @@ DESCRIPTION
   Convert asyncapi documents older to newer versions
 ```
 
-_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/convert.ts)_
+_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/convert.ts)_
 
 ## `asyncapi diff OLD NEW`
 
@@ -355,7 +355,7 @@ DESCRIPTION
   Find diff between two asyncapi files
 ```
 
-_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/diff.ts)_
+_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/diff.ts)_
 
 ## `asyncapi generate`
 
@@ -369,7 +369,7 @@ DESCRIPTION
   Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates.
 ```
 
-_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/generate/index.ts)_
+_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/generate/index.ts)_
 
 ## `asyncapi generate fromTemplate ASYNCAPI TEMPLATE`
 
@@ -394,10 +394,10 @@ FLAGS
   -p, --param=<value>...         Additional param to pass to templates
   -w, --watch                    Watches the template directory and the AsyncAPI document, and re-generate the files
                                  when changes occur. Ignores the output directory.
-  --debug                        Enable more specific errors in the console
-  --force-write                  Force writing of the generated files to given directory even if it is a git repo with
+      --debug                    Enable more specific errors in the console
+      --force-write              Force writing of the generated files to given directory even if it is a git repo with
                                  unstaged files or not empty dir (defaults to false)
-  --map-base-url=<value>         Maps all schema references from base url to local folder
+      --map-base-url=<value>     Maps all schema references from base url to local folder
 
 DESCRIPTION
   Generates whatever you want using templates compatible with AsyncAPI Generator.
@@ -406,7 +406,7 @@ EXAMPLES
   $ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write
 ```
 
-_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/generate/fromTemplate.ts)_
+_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/generate/fromTemplate.ts)_
 
 ## `asyncapi generate models LANGUAGE FILE`
 
@@ -427,66 +427,70 @@ ARGUMENTS
   FILE      Path or URL to the AsyncAPI document, or context-name
 
 FLAGS
-  -h, --help                                                           Show CLI help.
-  -o, --output=<value>                                                 The output directory where the models should be
-                                                                       written to. Omitting this flag will write the
-                                                                       models to `stdout`.
-  --csharpArrayType=<option>                                           [default: Array] C# specific, define which type
-                                                                       of array needs to be generated.
-                                                                       <options: Array|List>
-  --csharpAutoImplement                                                C# specific, define whether to generate
-                                                                       auto-implemented properties or not.
-  --csharpEqual                                                        C# specific, generate the models with the Equal
-                                                                       method overwritten
-  --csharpHashcode                                                     C# specific, generate the models with the
-                                                                       GetHashCode method overwritten
-  --csharpNewtonsoft                                                   C# specific, generate the models with newtonsoft
-                                                                       serialization support
-  --csharpSystemJson                                                   C# specific, generate the models with
-                                                                       System.Text.Json serialization support
-  --diagnostics-format=(json|stylish|junit|html|text|teamcity|pretty)  [default: stylish] format to use for validation
-                                                                       diagnostics
-  --fail-severity=(error|warn|info|hint)                               [default: error] diagnostics of this level or
-                                                                       above will trigger a failure exit code
-  --javaConstraints                                                    Java specific, generate the models with
-                                                                       constraints
-  --javaIncludeComments                                                Java specific, if enabled add comments while
-                                                                       generating models.
-  --javaJackson                                                        Java specific, generate the models with Jackson
-                                                                       serialization support
-  --[no-]log-diagnostics                                               log validation diagnostics or not
-  --namespace=<value>                                                  C#, C++ and PHP specific, define the namespace to
-                                                                       use for the generated models. This is required
-                                                                       when language is `csharp`,`c++` or `php`.
-  --packageName=<value>                                                Go, Java and Kotlin specific, define the package
-                                                                       to use for the generated models. This is required
-                                                                       when language is `go`, `java` or `kotlin`.
-  --tsEnumType=<option>                                                [default: enum] TypeScript specific, define which
-                                                                       type of enums needs to be generated.
-                                                                       <options: enum|union>
-  --tsExampleInstance                                                  Typescript specific, generate example of the
-                                                                       model
-  --tsExportType=<option>                                              [default: default] TypeScript specific, define
-                                                                       which type of export needs to be generated.
-                                                                       <options: default|named>
-  --tsIncludeComments                                                  TypeScript specific, if enabled add comments
-                                                                       while generating models.
-  --tsJsonBinPack                                                      TypeScript specific, define basic support for
-                                                                       serializing to and from binary with jsonbinpack.
-  --tsMarshalling                                                      TypeScript specific, generate the models with
-                                                                       marshalling functions.
-  --tsModelType=<option>                                               [default: class] TypeScript specific, define
-                                                                       which type of model needs to be generated.
-                                                                       <options: class|interface>
-  --tsModuleSystem=<option>                                            [default: ESM] TypeScript specific, define the
-                                                                       module system to be used.
-                                                                       <options: ESM|CJS>
+  -h, --help                                                               Show CLI help.
+  -o, --output=<value>                                                     The output directory where the models should
+                                                                           be written to. Omitting this flag will write
+                                                                           the models to `stdout`.
+      --csharpArrayType=<option>                                           [default: Array] C# specific, define which
+                                                                           type of array needs to be generated.
+                                                                           <options: Array|List>
+      --csharpAutoImplement                                                C# specific, define whether to generate
+                                                                           auto-implemented properties or not.
+      --csharpEqual                                                        C# specific, generate the models with the
+                                                                           Equal method overwritten
+      --csharpHashcode                                                     C# specific, generate the models with the
+                                                                           GetHashCode method overwritten
+      --csharpNewtonsoft                                                   C# specific, generate the models with
+                                                                           newtonsoft serialization support
+      --csharpSystemJson                                                   C# specific, generate the models with
+                                                                           System.Text.Json serialization support
+      --diagnostics-format=(json|stylish|junit|html|text|teamcity|pretty)  [default: stylish] format to use for
+                                                                           validation diagnostics
+      --fail-severity=(error|warn|info|hint)                               [default: error] diagnostics of this level or
+                                                                           above will trigger a failure exit code
+      --javaConstraints                                                    Java specific, generate the models with
+                                                                           constraints
+      --javaIncludeComments                                                Java specific, if enabled add comments while
+                                                                           generating models.
+      --javaJackson                                                        Java specific, generate the models with
+                                                                           Jackson serialization support
+      --[no-]log-diagnostics                                               log validation diagnostics or not
+      --namespace=<value>                                                  C#, C++ and PHP specific, define the
+                                                                           namespace to use for the generated models.
+                                                                           This is required when language is
+                                                                           `csharp`,`c++` or `php`.
+      --packageName=<value>                                                Go, Java and Kotlin specific, define the
+                                                                           package to use for the generated models. This
+                                                                           is required when language is `go`, `java` or
+                                                                           `kotlin`.
+      --tsEnumType=<option>                                                [default: enum] TypeScript specific, define
+                                                                           which type of enums needs to be generated.
+                                                                           <options: enum|union>
+      --tsExampleInstance                                                  Typescript specific, generate example of the
+                                                                           model
+      --tsExportType=<option>                                              [default: default] TypeScript specific,
+                                                                           define which type of export needs to be
+                                                                           generated.
+                                                                           <options: default|named>
+      --tsIncludeComments                                                  TypeScript specific, if enabled add comments
+                                                                           while generating models.
+      --tsJsonBinPack                                                      TypeScript specific, define basic support for
+                                                                           serializing to and from binary with
+                                                                           jsonbinpack.
+      --tsMarshalling                                                      TypeScript specific, generate the models with
+                                                                           marshalling functions.
+      --tsModelType=<option>                                               [default: class] TypeScript specific, define
+                                                                           which type of model needs to be generated.
+                                                                           <options: class|interface>
+      --tsModuleSystem=<option>                                            [default: ESM] TypeScript specific, define
+                                                                           the module system to be used.
+                                                                           <options: ESM|CJS>
 
 DESCRIPTION
   Generates typed models
 ```
 
-_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/generate/models.ts)_
+_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/generate/models.ts)_
 
 ## `asyncapi new`
 
@@ -543,7 +547,7 @@ EXAMPLES
   $ asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty	 - create a new file with a specific name, using one of the examples and without interactive mode
 ```
 
-_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/new/index.ts)_
+_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/new/index.ts)_
 
 ## `asyncapi new file`
 
@@ -600,7 +604,7 @@ EXAMPLES
   $ asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty	 - create a new file with a specific name, using one of the examples and without interactive mode
 ```
 
-_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/new/file.ts)_
+_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/new/file.ts)_
 
 ## `asyncapi new glee`
 
@@ -615,14 +619,14 @@ FLAGS
   -h, --help              Show CLI help.
   -n, --name=<value>      [default: project] Name of the Project
   -t, --template=<value>  [default: default] Name of the Template
-  --force-write           Force writing of the generated files to given directory even if it is a git repo with unstaged
+      --force-write       Force writing of the generated files to given directory even if it is a git repo with unstaged
                           files or not empty dir (defaults to false)
 
 DESCRIPTION
   Creates a new Glee project
 ```
 
-_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/new/glee.ts)_
+_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/new/glee.ts)_
 
 ## `asyncapi new project`
 
@@ -637,14 +641,14 @@ FLAGS
   -h, --help              Show CLI help.
   -n, --name=<value>      [default: project] Name of the Project
   -t, --template=<value>  [default: default] Name of the Template
-  --force-write           Force writing of the generated files to given directory even if it is a git repo with unstaged
+      --force-write       Force writing of the generated files to given directory even if it is a git repo with unstaged
                           files or not empty dir (defaults to false)
 
 DESCRIPTION
   Creates a new Glee project
 ```
 
-_See code: [src/commands/new/project.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/new/project.ts)_
+_See code: [src/commands/new/project.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/new/project.ts)_
 
 ## `asyncapi optimize [SPEC-FILE]`
 
@@ -665,7 +669,7 @@ FLAGS
   -p, --optimization=<option>...  [default: remove-components,reuse-components,move-to-components] select the type of
                                   optimizations that you want to apply.
                                   <options: remove-components|reuse-components|move-to-components>
-  --no-tty                        do not use an interactive terminal
+      --no-tty                    do not use an interactive terminal
 
 DESCRIPTION
   optimize asyncapi specification file
@@ -680,7 +684,7 @@ EXAMPLES
   $ asyncapi optimize ./asyncapi.yaml --optimization=remove-components,reuse-components,move-to-components --output=terminal --no-tty
 ```
 
-_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/optimize.ts)_
+_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/optimize.ts)_
 
 ## `asyncapi start`
 
@@ -694,7 +698,7 @@ DESCRIPTION
   Start asyncapi studio
 ```
 
-_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/start/index.ts)_
+_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/start/index.ts)_
 
 ## `asyncapi start studio`
 
@@ -713,7 +717,7 @@ DESCRIPTION
   starts a new local instance of Studio
 ```
 
-_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/start/studio.ts)_
+_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/start/studio.ts)_
 
 ## `asyncapi validate [SPEC-FILE]`
 
@@ -728,17 +732,17 @@ ARGUMENTS
   SPEC-FILE  spec path, url, or context-name
 
 FLAGS
-  -h, --help                                                           Show CLI help.
-  -w, --watch                                                          Enable watch mode
-  --diagnostics-format=(json|stylish|junit|html|text|teamcity|pretty)  [default: stylish] format to use for validation
-                                                                       diagnostics
-  --fail-severity=(error|warn|info|hint)                               [default: error] diagnostics of this level or
-                                                                       above will trigger a failure exit code
-  --[no-]log-diagnostics                                               log validation diagnostics or not
+  -h, --help                                                               Show CLI help.
+  -w, --watch                                                              Enable watch mode
+      --diagnostics-format=(json|stylish|junit|html|text|teamcity|pretty)  [default: stylish] format to use for
+                                                                           validation diagnostics
+      --fail-severity=(error|warn|info|hint)                               [default: error] diagnostics of this level or
+                                                                           above will trigger a failure exit code
+      --[no-]log-diagnostics                                               log validation diagnostics or not
 
 DESCRIPTION
   validate asyncapi file
 ```
 
-_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v1.5.16/src/commands/validate.ts)_
+_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v1.5.17/src/commands/validate.ts)_
 <!-- commandsstop -->