fix: Add description for the start command in AsyncAPI CLI

asyncapi · Oct 2, 2024 · 45cf81d · 45cf81d
1 parent 8f7b019
commit 45cf81d
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 29 deletions.
diff --git a/docs/usage.md b/docs/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,9 +19,11 @@ 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
@@ -33,36 +35,38 @@ 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`
 
@@ -714,6 +718,9 @@ 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.4.1/src/commands/start/index.ts)_
 
 ## `asyncapi start studio`
@@ -764,4 +771,5 @@ DESCRIPTION
 ```
 
 _See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/validate.ts)_
+
 <!-- commandsstop -->
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/commands/start/index.ts b/src/commands/start/index.ts
@@ -2,7 +2,7 @@ import Command from '../../core/base';
 import { Help } from '@oclif/core';
 
 export default class Start extends Command {
-  static description = '';
+  static description = 'Starts AsyncAPI-related services. Currently, it supports launching the AsyncAPI Studio';
   async run() {
     const help = new Help(this.config);
     help.showHelp(['start', '--help']);