From 3f625a3ebfbaf154f74396c50c0592b05d2f35e6 Mon Sep 17 00:00:00 2001 From: asyncapi-bot Date: Thu, 17 Aug 2023 13:32:29 +0200 Subject: [PATCH] docs(cli): update latest cli documentation (#2073) --- pages/docs/tools/cli/usage.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/pages/docs/tools/cli/usage.md b/pages/docs/tools/cli/usage.md index 72481b3de32..b087e53c9a1 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.52.4 linux-x64 node-v18.17.1 +@asyncapi/cli/0.52.5 linux-x64 node-v18.17.0 $ 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.52.4/src/commands/bundle.ts)_ +_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v0.52.5/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.52.4/src/commands/config/index.ts)_ +_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v0.52.5/src/commands/config/index.ts)_ ## `asyncapi config context` @@ -127,14 +127,15 @@ Add a context to the store ``` USAGE - $ asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH [-h] + $ asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH [-h] [-s] ARGUMENTS CONTEXT-NAME context name SPEC-FILE-PATH file path of the spec file FLAGS - -h, --help Show CLI help. + -h, --help Show CLI help. + -s, --set-current Set context being added as the current context DESCRIPTION Add a context to the store @@ -281,7 +282,7 @@ DESCRIPTION Convert asyncapi documents older to newer versions ``` -_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v0.52.4/src/commands/convert.ts)_ +_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v0.52.5/src/commands/convert.ts)_ ## `asyncapi diff OLD NEW` @@ -336,7 +337,7 @@ DESCRIPTION Find diff between two asyncapi files ``` -_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v0.52.4/src/commands/diff.ts)_ +_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v0.52.5/src/commands/diff.ts)_ ## `asyncapi generate` @@ -350,7 +351,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.52.4/src/commands/generate/index.ts)_ +_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v0.52.5/src/commands/generate/index.ts)_ ## `asyncapi generate fromTemplate ASYNCAPI TEMPLATE` @@ -479,7 +480,7 @@ DESCRIPTION Creates a new asyncapi file ``` -_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v0.52.4/src/commands/new/index.ts)_ +_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v0.52.5/src/commands/new/index.ts)_ ## `asyncapi new file` @@ -567,7 +568,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.52.4/src/commands/optimize.ts)_ +_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v0.52.5/src/commands/optimize.ts)_ ## `asyncapi start` @@ -581,7 +582,7 @@ DESCRIPTION Start asyncapi studio ``` -_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v0.52.4/src/commands/start/index.ts)_ +_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v0.52.5/src/commands/start/index.ts)_ ## `asyncapi start studio` @@ -625,5 +626,5 @@ DESCRIPTION validate asyncapi file ``` -_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v0.52.4/src/commands/validate.ts)_ +_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v0.52.5/src/commands/validate.ts)_