diff --git a/docs/usage.md b/docs/usage.md index b087e53c9a1..18f01491e1a 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -29,7 +29,7 @@ $ npm install -g @asyncapi/cli $ asyncapi COMMAND running command... $ asyncapi (--version) -@asyncapi/cli/0.52.5 linux-x64 node-v18.17.0 +@asyncapi/cli/0.53.0 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.5/src/commands/bundle.ts)_ +_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v0.53.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.52.5/src/commands/config/index.ts)_ +_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v0.53.0/src/commands/config/index.ts)_ ## `asyncapi config context` @@ -282,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.5/src/commands/convert.ts)_ +_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v0.53.0/src/commands/convert.ts)_ ## `asyncapi diff OLD NEW` @@ -337,7 +337,7 @@ DESCRIPTION Find diff between two asyncapi files ``` -_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v0.52.5/src/commands/diff.ts)_ +_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v0.53.0/src/commands/diff.ts)_ ## `asyncapi generate` @@ -351,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.5/src/commands/generate/index.ts)_ +_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v0.53.0/src/commands/generate/index.ts)_ ## `asyncapi generate fromTemplate ASYNCAPI TEMPLATE` @@ -469,18 +469,51 @@ USAGE $ asyncapi new [-h] [-n ] [-e ] [-s] [-p ] [--no-tty] FLAGS - -e, --example= name of the example to use - -h, --help Show CLI help. - -n, --file-name= name of the file - -p, --port= port in which to start Studio - -s, --studio open in Studio - --no-tty do not use an interactive terminal + -e, --example= + name of the example to use. Available examples are: + - simple.yml + - anyof.yml + - application-headers.yml + - correlation-id.yml + - websocket-gemini.yml + - gitter-streaming.yml + - mercure.yml + - not.yml + - operation-security.yml + - oneof.yml + - rpc-client.yml + - rpc-server.yml + - slack-rtm.yml + - tutorial.yml + - streetlights-kafka.yml + - streetlights-operation-security.yml + - streetlights-mqtt.yml + + -h, --help + Show CLI help. + + -n, --file-name= + name of the file + + -p, --port= + port in which to start Studio + + -s, --studio + open in Studio + + --no-tty + do not use an interactive terminal DESCRIPTION Creates a new asyncapi file + +EXAMPLES + $ asyncapi new - start creation of a file in interactive mode + + $ 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.52.5/src/commands/new/index.ts)_ +_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v0.53.0/src/commands/new/index.ts)_ ## `asyncapi new file` @@ -491,15 +524,48 @@ USAGE $ asyncapi new file [-h] [-n ] [-e ] [-s] [-p ] [--no-tty] FLAGS - -e, --example= name of the example to use - -h, --help Show CLI help. - -n, --file-name= name of the file - -p, --port= port in which to start Studio - -s, --studio open in Studio - --no-tty do not use an interactive terminal + -e, --example= + name of the example to use. Available examples are: + - simple.yml + - anyof.yml + - application-headers.yml + - correlation-id.yml + - websocket-gemini.yml + - gitter-streaming.yml + - mercure.yml + - not.yml + - operation-security.yml + - oneof.yml + - rpc-client.yml + - rpc-server.yml + - slack-rtm.yml + - tutorial.yml + - streetlights-kafka.yml + - streetlights-operation-security.yml + - streetlights-mqtt.yml + + -h, --help + Show CLI help. + + -n, --file-name= + name of the file + + -p, --port= + port in which to start Studio + + -s, --studio + open in Studio + + --no-tty + do not use an interactive terminal DESCRIPTION Creates a new asyncapi file + +EXAMPLES + $ asyncapi new - start creation of a file in interactive mode + + $ 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 ``` ## `asyncapi new glee` @@ -568,7 +634,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.5/src/commands/optimize.ts)_ +_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v0.53.0/src/commands/optimize.ts)_ ## `asyncapi start` @@ -582,7 +648,7 @@ DESCRIPTION Start asyncapi studio ``` -_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v0.52.5/src/commands/start/index.ts)_ +_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v0.53.0/src/commands/start/index.ts)_ ## `asyncapi start studio` @@ -626,5 +692,5 @@ DESCRIPTION validate asyncapi file ``` -_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v0.52.5/src/commands/validate.ts)_ +_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v0.53.0/src/commands/validate.ts)_ diff --git a/package-lock.json b/package-lock.json index 9037cbcc891..016116fcafd 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@asyncapi/cli", - "version": "0.53.0", + "version": "0.54.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@asyncapi/cli", - "version": "0.53.0", + "version": "0.54.0", "license": "Apache-2.0", "dependencies": { "@asyncapi/avro-schema-parser": "^3.0.2", diff --git a/package.json b/package.json index 6f087e9d66d..5ed6571ef80 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@asyncapi/cli", "description": "All in one CLI for all AsyncAPI tools", - "version": "0.53.0", + "version": "0.54.0", "author": "@asyncapi", "bin": { "asyncapi": "./bin/run"