Skip to content

Commit 2e5c6cd

Browse files
fix: add description for the start command in AsyncAPI CLI (#1534) (#1537)
Co-authored-by: Ashish Padhy <100484401+Shurtu-gal@users.noreply.github.com>
1 parent adc448c commit 2e5c6cd

File tree

2 files changed

+39
-29
lines changed

2 files changed

+39
-29
lines changed

docs/usage.md

Lines changed: 38 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: 'Usage'
2+
title: "Usage"
33
weight: 40
44
---
55

6-
<!--
6+
<!--
77
8-
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 -
8+
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 -
99
1010
* 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.
1111
* 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.
1919
-->
2020

2121
The AsyncAPI CLI makes it easier to work with AsyncAPI documents.
22+
2223
# Usage
2324

2425
<!-- usage -->
26+
2527
```sh-session
2628
$ npm install -g @asyncapi/cli
2729
$ asyncapi COMMAND
@@ -33,36 +35,38 @@ USAGE
3335
$ asyncapi COMMAND
3436
...
3537
```
38+
3639
<!-- usagestop -->
3740

3841
# Commands
3942

4043
<!-- commands -->
41-
* [`asyncapi bundle`](#asyncapi-bundle)
42-
* [`asyncapi config`](#asyncapi-config)
43-
* [`asyncapi config analytics`](#asyncapi-config-analytics)
44-
* [`asyncapi config context`](#asyncapi-config-context)
45-
* [`asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`](#asyncapi-config-context-add-context-name-spec-file-path)
46-
* [`asyncapi config context current`](#asyncapi-config-context-current)
47-
* [`asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`](#asyncapi-config-context-edit-context-name-new-spec-file-path)
48-
* [`asyncapi config context init [CONTEXT-FILE-PATH]`](#asyncapi-config-context-init-context-file-path)
49-
* [`asyncapi config context list`](#asyncapi-config-context-list)
50-
* [`asyncapi config context remove CONTEXT-NAME`](#asyncapi-config-context-remove-context-name)
51-
* [`asyncapi config context use CONTEXT-NAME`](#asyncapi-config-context-use-context-name)
52-
* [`asyncapi config versions`](#asyncapi-config-versions)
53-
* [`asyncapi convert [SPEC-FILE]`](#asyncapi-convert-spec-file)
54-
* [`asyncapi diff OLD NEW`](#asyncapi-diff-old-new)
55-
* [`asyncapi generate`](#asyncapi-generate)
56-
* [`asyncapi generate fromTemplate ASYNCAPI TEMPLATE`](#asyncapi-generate-fromtemplate-asyncapi-template)
57-
* [`asyncapi generate models LANGUAGE FILE`](#asyncapi-generate-models-language-file)
58-
* [`asyncapi new`](#asyncapi-new)
59-
* [`asyncapi new file`](#asyncapi-new-file)
60-
* [`asyncapi new glee`](#asyncapi-new-glee)
61-
* [`asyncapi new template`](#asyncapi-new-template)
62-
* [`asyncapi optimize [SPEC-FILE]`](#asyncapi-optimize-spec-file)
63-
* [`asyncapi start`](#asyncapi-start)
64-
* [`asyncapi start studio`](#asyncapi-start-studio)
65-
* [`asyncapi validate [SPEC-FILE]`](#asyncapi-validate-spec-file)
44+
45+
- [`asyncapi bundle`](#asyncapi-bundle)
46+
- [`asyncapi config`](#asyncapi-config)
47+
- [`asyncapi config analytics`](#asyncapi-config-analytics)
48+
- [`asyncapi config context`](#asyncapi-config-context)
49+
- [`asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`](#asyncapi-config-context-add-context-name-spec-file-path)
50+
- [`asyncapi config context current`](#asyncapi-config-context-current)
51+
- [`asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`](#asyncapi-config-context-edit-context-name-new-spec-file-path)
52+
- [`asyncapi config context init [CONTEXT-FILE-PATH]`](#asyncapi-config-context-init-context-file-path)
53+
- [`asyncapi config context list`](#asyncapi-config-context-list)
54+
- [`asyncapi config context remove CONTEXT-NAME`](#asyncapi-config-context-remove-context-name)
55+
- [`asyncapi config context use CONTEXT-NAME`](#asyncapi-config-context-use-context-name)
56+
- [`asyncapi config versions`](#asyncapi-config-versions)
57+
- [`asyncapi convert [SPEC-FILE]`](#asyncapi-convert-spec-file)
58+
- [`asyncapi diff OLD NEW`](#asyncapi-diff-old-new)
59+
- [`asyncapi generate`](#asyncapi-generate)
60+
- [`asyncapi generate fromTemplate ASYNCAPI TEMPLATE`](#asyncapi-generate-fromtemplate-asyncapi-template)
61+
- [`asyncapi generate models LANGUAGE FILE`](#asyncapi-generate-models-language-file)
62+
- [`asyncapi new`](#asyncapi-new)
63+
- [`asyncapi new file`](#asyncapi-new-file)
64+
- [`asyncapi new glee`](#asyncapi-new-glee)
65+
- [`asyncapi new template`](#asyncapi-new-template)
66+
- [`asyncapi optimize [SPEC-FILE]`](#asyncapi-optimize-spec-file)
67+
- [`asyncapi start`](#asyncapi-start)
68+
- [`asyncapi start studio`](#asyncapi-start-studio)
69+
- [`asyncapi validate [SPEC-FILE]`](#asyncapi-validate-spec-file)
6670

6771
## `asyncapi bundle`
6872

@@ -715,8 +719,13 @@ USAGE
715719
$ asyncapi start
716720
```
717721

722+
723+
DESCRIPTION
724+
main command for starting asyncapi services, currently studio only.
725+
718726
_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/start/index.ts)_
719727

728+
720729
## `asyncapi start studio`
721730

722731
starts a new local instance of Studio
@@ -765,4 +774,5 @@ DESCRIPTION
765774
```
766775

767776
_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/validate.ts)_
777+
768778
<!-- commandsstop -->

src/commands/start/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import Command from '../../core/base';
22
import { Help } from '@oclif/core';
33

44
export default class Start extends Command {
5-
static description = '';
5+
static description = 'Starts AsyncAPI-related services. Currently, it supports launching the AsyncAPI Studio';
66
async run() {
77
const help = new Help(this.config);
88
help.showHelp(['start', '--help']);

0 commit comments

Comments
 (0)