From ae70ac3f5e057bf1bdcb47faea5e27e1c409743e Mon Sep 17 00:00:00 2001 From: asyncapi-bot Date: Thu, 14 Sep 2023 10:03:26 +0000 Subject: [PATCH] docs(cli): update latest cli docs --- pages/docs/tools/cli/usage.md | 52 +++++++++++++++++++++++++++-------- 1 file changed, 41 insertions(+), 11 deletions(-) diff --git a/pages/docs/tools/cli/usage.md b/pages/docs/tools/cli/usage.md index a102bae1f12..7688b19a7b2 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/0.54.8 linux-x64 node-v18.17.1 +@asyncapi/cli/0.55.0 linux-x64 node-v18.17.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/v0.54.8/src/commands/bundle.ts)_ +_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v0.55.0/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/v0.54.8/src/commands/config/index.ts)_ +_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/config/index.ts)_ ## `asyncapi config context` @@ -121,6 +121,8 @@ DESCRIPTION Manage short aliases for full paths to AsyncAPI documents ``` +_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/config/context/index.ts)_ + ## `asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH` Add a context to the store @@ -141,6 +143,8 @@ DESCRIPTION Add a context to the store ``` +_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/config/context/add.ts)_ + ## `asyncapi config context current` Shows the current context that is being used @@ -156,6 +160,8 @@ DESCRIPTION Shows the current context that is being used ``` +_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/config/context/current.ts)_ + ## `asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH` Edit a context in the store @@ -175,6 +181,8 @@ DESCRIPTION Edit a context in the store ``` +_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/config/context/edit.ts)_ + ## `asyncapi config context init [CONTEXT-FILE-PATH]` Initialize context @@ -196,6 +204,8 @@ DESCRIPTION Initialize context ``` +_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/config/context/init.ts)_ + ## `asyncapi config context list` List all the stored contexts in the store @@ -211,6 +221,8 @@ DESCRIPTION List all the stored contexts in the store ``` +_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/config/context/list.ts)_ + ## `asyncapi config context remove CONTEXT-NAME` Delete a context from the store @@ -229,6 +241,8 @@ DESCRIPTION Delete a context from the store ``` +_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/config/context/remove.ts)_ + ## `asyncapi config context use CONTEXT-NAME` Set a context as current @@ -247,6 +261,8 @@ DESCRIPTION Set a context as current ``` +_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/config/context/use.ts)_ + ## `asyncapi config versions` Show versions of AsyncAPI tools used @@ -262,6 +278,8 @@ DESCRIPTION Show versions of AsyncAPI tools used ``` +_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/config/versions.ts)_ + ## `asyncapi convert [SPEC-FILE]` Convert asyncapi documents older to newer versions @@ -276,13 +294,13 @@ ARGUMENTS FLAGS -h, --help Show CLI help. -o, --output= path to the file where the result is saved - -t, --target-version= [default: 2.6.0] asyncapi version to convert to + -t, --target-version= [default: 3.0.0] asyncapi version to convert to DESCRIPTION Convert asyncapi documents older to newer versions ``` -_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v0.54.8/src/commands/convert.ts)_ +_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/convert.ts)_ ## `asyncapi diff OLD NEW` @@ -337,7 +355,7 @@ DESCRIPTION Find diff between two asyncapi files ``` -_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v0.54.8/src/commands/diff.ts)_ +_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/diff.ts)_ ## `asyncapi generate` @@ -351,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/v0.54.8/src/commands/generate/index.ts)_ +_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/generate/index.ts)_ ## `asyncapi generate fromTemplate ASYNCAPI TEMPLATE` @@ -388,6 +406,8 @@ 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/v0.55.0/src/commands/generate/fromTemplate.ts)_ + ## `asyncapi generate models LANGUAGE FILE` Generates typed models @@ -460,6 +480,8 @@ DESCRIPTION Generates typed models ``` +_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/generate/models.ts)_ + ## `asyncapi new` Creates a new asyncapi file @@ -513,7 +535,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/v0.54.8/src/commands/new/index.ts)_ +_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/new/index.ts)_ ## `asyncapi new file` @@ -568,6 +590,8 @@ 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/v0.55.0/src/commands/new/file.ts)_ + ## `asyncapi new glee` Creates a new Glee project @@ -584,6 +608,8 @@ DESCRIPTION Creates a new Glee project ``` +_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/new/glee.ts)_ + ## `asyncapi new project` Creates a new Glee project @@ -600,6 +626,8 @@ DESCRIPTION Creates a new Glee project ``` +_See code: [src/commands/new/project.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/new/project.ts)_ + ## `asyncapi optimize [SPEC-FILE]` optimize asyncapi specification file @@ -634,7 +662,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/v0.54.8/src/commands/optimize.ts)_ +_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/optimize.ts)_ ## `asyncapi start` @@ -648,7 +676,7 @@ DESCRIPTION Start asyncapi studio ``` -_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v0.54.8/src/commands/start/index.ts)_ +_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/start/index.ts)_ ## `asyncapi start studio` @@ -667,6 +695,8 @@ DESCRIPTION starts a new local instance of Studio ``` +_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/start/studio.ts)_ + ## `asyncapi validate [SPEC-FILE]` validate asyncapi file @@ -692,5 +722,5 @@ DESCRIPTION validate asyncapi file ``` -_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v0.54.8/src/commands/validate.ts)_ +_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v0.55.0/src/commands/validate.ts)_