From 7b7086192a857f0de9527a2301f47385b30baf6a Mon Sep 17 00:00:00 2001
From: asyncapi-bot <bot+chan@asyncapi.io>
Date: Tue, 22 Oct 2024 11:06:36 +0200
Subject: [PATCH] docs(cli): update latest cli documentation (#3314)

---
 markdown/docs/tools/cli/usage.md | 121 +++++++++++++++----------------
 1 file changed, 58 insertions(+), 63 deletions(-)

diff --git a/markdown/docs/tools/cli/usage.md b/markdown/docs/tools/cli/usage.md
index 269d438fa4d..d4cae23662b 100644
--- a/markdown/docs/tools/cli/usage.md
+++ b/markdown/docs/tools/cli/usage.md
@@ -1,11 +1,11 @@
 ---
-title: "Usage"
+title: 'Usage'
 weight: 40
 ---
 
-<!--
+<!-- 
 
-This file is automatically generated from updateUsageDocs.js script. In package.json in line 158-161 lines the following steps has been executed in order to run this script successfully -
+This file is automatically generated from updateUsageDocs.js script. In package.json in line 158-161 lines the following steps has been executed in order to run this script successfully - 
 
 * generate:readme:create: It creates the initial content for the README file by printing the usage and commands tags using printf and redirects the output to scripts/README.md file.
 * generate:readme:commands: It changes the directory to the scripts folder and executes the oclif readme command. This command generates the usage and commands sections based on the CLI commands and updates the content in the scripts/README.md file.
@@ -19,54 +19,50 @@ This file is automatically generated from updateUsageDocs.js script. In package.
 -->
 
 The AsyncAPI CLI makes it easier to work with AsyncAPI documents.
-
 # Usage
 
 <!-- usage -->
-
 ```sh-session
 $ npm install -g @asyncapi/cli
 $ asyncapi COMMAND
 running command...
 $ asyncapi (--version)
-@asyncapi/cli/2.5.0 linux-x64 node-v18.20.4
+@asyncapi/cli/2.7.1 linux-x64 node-v18.20.4
 $ asyncapi --help [COMMAND]
 USAGE
   $ asyncapi COMMAND
 ...
 ```
-
 <!-- usagestop -->
 
 # Commands
 
 <!-- commands -->
-
-- [`asyncapi bundle`](#asyncapi-bundle)
-- [`asyncapi config`](#asyncapi-config)
-- [`asyncapi config analytics`](#asyncapi-config-analytics)
-- [`asyncapi config context`](#asyncapi-config-context)
-- [`asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`](#asyncapi-config-context-add-context-name-spec-file-path)
-- [`asyncapi config context current`](#asyncapi-config-context-current)
-- [`asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`](#asyncapi-config-context-edit-context-name-new-spec-file-path)
-- [`asyncapi config context init [CONTEXT-FILE-PATH]`](#asyncapi-config-context-init-context-file-path)
-- [`asyncapi config context list`](#asyncapi-config-context-list)
-- [`asyncapi config context remove CONTEXT-NAME`](#asyncapi-config-context-remove-context-name)
-- [`asyncapi config context use CONTEXT-NAME`](#asyncapi-config-context-use-context-name)
-- [`asyncapi config versions`](#asyncapi-config-versions)
-- [`asyncapi convert [SPEC-FILE]`](#asyncapi-convert-spec-file)
-- [`asyncapi diff OLD NEW`](#asyncapi-diff-old-new)
-- [`asyncapi generate`](#asyncapi-generate)
-- [`asyncapi generate fromTemplate ASYNCAPI TEMPLATE`](#asyncapi-generate-fromtemplate-asyncapi-template)
-- [`asyncapi generate models LANGUAGE FILE`](#asyncapi-generate-models-language-file)
-- [`asyncapi new`](#asyncapi-new)
-- [`asyncapi new file`](#asyncapi-new-file)
-- [`asyncapi new glee`](#asyncapi-new-glee)
-- [`asyncapi new template`](#asyncapi-new-template)
-- [`asyncapi optimize [SPEC-FILE]`](#asyncapi-optimize-spec-file)
-- [`asyncapi start`](#asyncapi-start)
-- [`asyncapi start studio`](#asyncapi-start-studio)
-- [`asyncapi validate [SPEC-FILE]`](#asyncapi-validate-spec-file)
+* [`asyncapi bundle`](#asyncapi-bundle)
+* [`asyncapi config`](#asyncapi-config)
+* [`asyncapi config analytics`](#asyncapi-config-analytics)
+* [`asyncapi config context`](#asyncapi-config-context)
+* [`asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`](#asyncapi-config-context-add-context-name-spec-file-path)
+* [`asyncapi config context current`](#asyncapi-config-context-current)
+* [`asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`](#asyncapi-config-context-edit-context-name-new-spec-file-path)
+* [`asyncapi config context init [CONTEXT-FILE-PATH]`](#asyncapi-config-context-init-context-file-path)
+* [`asyncapi config context list`](#asyncapi-config-context-list)
+* [`asyncapi config context remove CONTEXT-NAME`](#asyncapi-config-context-remove-context-name)
+* [`asyncapi config context use CONTEXT-NAME`](#asyncapi-config-context-use-context-name)
+* [`asyncapi config versions`](#asyncapi-config-versions)
+* [`asyncapi convert [SPEC-FILE]`](#asyncapi-convert-spec-file)
+* [`asyncapi diff OLD NEW`](#asyncapi-diff-old-new)
+* [`asyncapi generate`](#asyncapi-generate)
+* [`asyncapi generate fromTemplate ASYNCAPI TEMPLATE`](#asyncapi-generate-fromtemplate-asyncapi-template)
+* [`asyncapi generate models LANGUAGE FILE`](#asyncapi-generate-models-language-file)
+* [`asyncapi new`](#asyncapi-new)
+* [`asyncapi new file`](#asyncapi-new-file)
+* [`asyncapi new glee`](#asyncapi-new-glee)
+* [`asyncapi new template`](#asyncapi-new-template)
+* [`asyncapi optimize [SPEC-FILE]`](#asyncapi-optimize-spec-file)
+* [`asyncapi start`](#asyncapi-start)
+* [`asyncapi start studio`](#asyncapi-start-studio)
+* [`asyncapi validate [SPEC-FILE]`](#asyncapi-validate-spec-file)
 
 ## `asyncapi bundle`
 
@@ -103,7 +99,7 @@ EXAMPLES
   $ asyncapi bundle ./asyncapi.yaml -o final-asyncapi.yaml --base ../public-api/main.yaml --baseDir ./social-media/comments-service
 ```
 
-_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/bundle.ts)_
+_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/bundle.ts)_
 
 ## `asyncapi config`
 
@@ -117,7 +113,7 @@ DESCRIPTION
   CLI config settings
 ```
 
-_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/index.ts)_
+_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/config/index.ts)_
 
 ## `asyncapi config analytics`
 
@@ -137,7 +133,7 @@ DESCRIPTION
   Enable or disable analytics for metrics collection
 ```
 
-_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/analytics.ts)_
+_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/config/analytics.ts)_
 
 ## `asyncapi config context`
 
@@ -151,7 +147,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/v2.5.0/src/commands/config/context/index.ts)_
+_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/config/context/index.ts)_
 
 ## `asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`
 
@@ -173,7 +169,7 @@ DESCRIPTION
   Add a context to the store
 ```
 
-_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/context/add.ts)_
+_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/config/context/add.ts)_
 
 ## `asyncapi config context current`
 
@@ -190,7 +186,7 @@ DESCRIPTION
   Shows the current context that is being used
 ```
 
-_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/context/current.ts)_
+_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/config/context/current.ts)_
 
 ## `asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`
 
@@ -211,7 +207,7 @@ DESCRIPTION
   Edit a context in the store
 ```
 
-_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/context/edit.ts)_
+_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/config/context/edit.ts)_
 
 ## `asyncapi config context init [CONTEXT-FILE-PATH]`
 
@@ -234,7 +230,7 @@ DESCRIPTION
   Initialize context
 ```
 
-_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/context/init.ts)_
+_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/config/context/init.ts)_
 
 ## `asyncapi config context list`
 
@@ -251,7 +247,7 @@ DESCRIPTION
   List all the stored contexts in the store
 ```
 
-_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/context/list.ts)_
+_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/config/context/list.ts)_
 
 ## `asyncapi config context remove CONTEXT-NAME`
 
@@ -271,7 +267,7 @@ DESCRIPTION
   Delete a context from the store
 ```
 
-_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/context/remove.ts)_
+_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/config/context/remove.ts)_
 
 ## `asyncapi config context use CONTEXT-NAME`
 
@@ -291,7 +287,7 @@ DESCRIPTION
   Set a context as current
 ```
 
-_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/context/use.ts)_
+_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/config/context/use.ts)_
 
 ## `asyncapi config versions`
 
@@ -308,7 +304,7 @@ DESCRIPTION
   Show versions of AsyncAPI tools used
 ```
 
-_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/versions.ts)_
+_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/config/versions.ts)_
 
 ## `asyncapi convert [SPEC-FILE]`
 
@@ -336,7 +332,7 @@ DESCRIPTION
   Convert asyncapi documents older to newer versions or OpenAPI/postman-collection documents to AsyncAPI
 ```
 
-_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/convert.ts)_
+_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/convert.ts)_
 
 ## `asyncapi diff OLD NEW`
 
@@ -376,7 +372,7 @@ DESCRIPTION
   Find diff between two asyncapi files
 ```
 
-_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/diff.ts)_
+_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/diff.ts)_
 
 ## `asyncapi generate`
 
@@ -390,7 +386,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/v2.5.0/src/commands/generate/index.ts)_
+_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/generate/index.ts)_
 
 ## `asyncapi generate fromTemplate ASYNCAPI TEMPLATE`
 
@@ -435,7 +431,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/v2.5.0/src/commands/generate/fromTemplate.ts)_
+_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/generate/fromTemplate.ts)_
 
 ## `asyncapi generate models LANGUAGE FILE`
 
@@ -506,7 +502,7 @@ DESCRIPTION
   Generates typed models
 ```
 
-_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/generate/models.ts)_
+_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/generate/models.ts)_
 
 ## `asyncapi new`
 
@@ -564,7 +560,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/v2.5.0/src/commands/new/index.ts)_
+_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/new/index.ts)_
 
 ## `asyncapi new file`
 
@@ -622,7 +618,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/v2.5.0/src/commands/new/file.ts)_
+_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/new/file.ts)_
 
 ## `asyncapi new glee`
 
@@ -644,7 +640,7 @@ DESCRIPTION
   Creates a new Glee project
 ```
 
-_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/new/glee.ts)_
+_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/new/glee.ts)_
 
 ## `asyncapi new template`
 
@@ -668,7 +664,7 @@ DESCRIPTION
   Creates a new template
 ```
 
-_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/new/template.ts)_
+_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/new/template.ts)_
 
 ## `asyncapi optimize [SPEC-FILE]`
 
@@ -710,21 +706,21 @@ EXAMPLES
   $ asyncapi optimize ./asyncapi.yaml --ignore=schema
 ```
 
-_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/optimize.ts)_
+_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/optimize.ts)_
 
 ## `asyncapi start`
 
+Starts AsyncAPI-related services. Currently, it supports launching the AsyncAPI Studio
+
 ```
 USAGE
   $ asyncapi start
-```
-
 
 DESCRIPTION
-main command for starting asyncapi services, currently studio only.
-
-_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/start/index.ts)_
+  Starts AsyncAPI-related services. Currently, it supports launching the AsyncAPI Studio
+```
 
+_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/start/index.ts)_
 
 ## `asyncapi start studio`
 
@@ -743,7 +739,7 @@ DESCRIPTION
   starts a new local instance of Studio
 ```
 
-_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/start/studio.ts)_
+_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/start/studio.ts)_
 
 ## `asyncapi validate [SPEC-FILE]`
 
@@ -773,6 +769,5 @@ DESCRIPTION
   validate asyncapi file
 ```
 
-_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/validate.ts)_
-
+_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.7.1/src/commands/validate.ts)_
 <!-- commandsstop -->