From 2e5c6cd224eef9f8924c7d7ec961b37fd0123f21 Mon Sep 17 00:00:00 2001 From: Taufiq Hassan <145540627+toffee-k21@users.noreply.github.com> Date: Sun, 20 Oct 2024 20:55:23 +0530 Subject: [PATCH] fix: add description for the start command in AsyncAPI CLI (#1534) (#1537) Co-authored-by: Ashish Padhy <100484401+Shurtu-gal@users.noreply.github.com> --- docs/usage.md | 66 +++++++++++++++++++++---------------- src/commands/start/index.ts | 2 +- 2 files changed, 39 insertions(+), 29 deletions(-) diff --git a/docs/usage.md b/docs/usage.md index 95669e0efd6..269d438fa4d 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -1,11 +1,11 @@ --- -title: 'Usage' +title: "Usage" weight: 40 --- - The AsyncAPI CLI makes it easier to work with AsyncAPI documents. + # Usage + ```sh-session $ npm install -g @asyncapi/cli $ asyncapi COMMAND @@ -33,36 +35,38 @@ USAGE $ asyncapi COMMAND ... ``` + # 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` @@ -715,8 +719,13 @@ 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)_ + ## `asyncapi start studio` starts a new local instance of Studio @@ -765,4 +774,5 @@ DESCRIPTION ``` _See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/validate.ts)_ + diff --git a/src/commands/start/index.ts b/src/commands/start/index.ts index 8c75ce39b69..96af1f83f10 100644 --- 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']);