diff --git a/docs/usage.md b/docs/usage.md index 06d1a23ab1f..64c5cf30a8d 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -27,7 +27,7 @@ $ npm install -g @asyncapi/cli $ asyncapi COMMAND running command... $ asyncapi (--version) -@asyncapi/cli/1.12.0 linux-x64 node-v18.20.2 +@asyncapi/cli/1.12.1 linux-x64 node-v18.20.2 $ asyncapi --help [COMMAND] USAGE $ asyncapi COMMAND @@ -65,33 +65,38 @@ USAGE ## `asyncapi bundle` -bundle one or multiple asyncapi documents and their references together. +Bundle one or multiple AsyncAPI Documents and their references together. ``` USAGE - $ asyncapi bundle [-h] [-o ] [-r] [-b ] + $ asyncapi bundle [-h] [-o ] [-b ] [-d ] [-x] FLAGS - -b, --base= Path to the file which will act as a base. This is required when some properties are - to needed to be overwritten. - -h, --help Show CLI help. - -o, --output= The output file name. Omitting this flag the result will be printed in the console. - -r, --reference-into-components Bundle the message $refs into components object. + -b, --base= Path to the file which will act as a base. This is required when some properties need to be + overwritten. + -d, --baseDir= One relative/absolute path to directory relative to which paths to AsyncAPI Documents that + should be bundled will be resolved. + -h, --help Show CLI help. + -o, --output= The output file name. Omitting this flag the result will be printed in the console. + -x, --xOrigin Pass this switch to generate properties "x-origin" that will contain historical values of + dereferenced "$ref"s. DESCRIPTION - bundle one or multiple asyncapi documents and their references together. + Bundle one or multiple AsyncAPI Documents and their references together. EXAMPLES - $ asyncapi bundle ./asyncapi.yaml > final-asyncapi.yaml - $ asyncapi bundle ./asyncapi.yaml --output final-asyncapi.yaml - $ asyncapi bundle ./asyncapi.yaml ./features.yaml --reference-into-components + $ asyncapi bundle ./asyncapi.yaml ./features.yaml + + $ asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./main.yaml + + $ asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./main.yaml --xOrigin - $ asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./asyncapi.yaml --reference-into-components + $ asyncapi bundle ./asyncapi.yaml -o final-asyncapi.yaml --base ../public-api/main.yaml --baseDir ./social-media/comments-service ``` -_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/bundle.ts)_ +_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/bundle.ts)_ ## `asyncapi config` @@ -105,7 +110,7 @@ DESCRIPTION CLI config settings ``` -_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/config/index.ts)_ +_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/config/index.ts)_ ## `asyncapi config analytics` @@ -125,7 +130,7 @@ DESCRIPTION Enable or disable analytics for metrics collection ``` -_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/config/analytics.ts)_ +_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/config/analytics.ts)_ ## `asyncapi config context` @@ -139,7 +144,7 @@ DESCRIPTION Manage short aliases for full paths to AsyncAPI documents ``` -_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/config/context/index.ts)_ +_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/config/context/index.ts)_ ## `asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH` @@ -161,7 +166,7 @@ DESCRIPTION Add a context to the store ``` -_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/config/context/add.ts)_ +_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/config/context/add.ts)_ ## `asyncapi config context current` @@ -178,7 +183,7 @@ DESCRIPTION Shows the current context that is being used ``` -_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/config/context/current.ts)_ +_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/config/context/current.ts)_ ## `asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH` @@ -199,7 +204,7 @@ DESCRIPTION Edit a context in the store ``` -_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/config/context/edit.ts)_ +_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/config/context/edit.ts)_ ## `asyncapi config context init [CONTEXT-FILE-PATH]` @@ -222,7 +227,7 @@ DESCRIPTION Initialize context ``` -_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/config/context/init.ts)_ +_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/config/context/init.ts)_ ## `asyncapi config context list` @@ -239,7 +244,7 @@ DESCRIPTION List all the stored contexts in the store ``` -_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/config/context/list.ts)_ +_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/config/context/list.ts)_ ## `asyncapi config context remove CONTEXT-NAME` @@ -259,7 +264,7 @@ DESCRIPTION Delete a context from the store ``` -_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/config/context/remove.ts)_ +_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/config/context/remove.ts)_ ## `asyncapi config context use CONTEXT-NAME` @@ -279,7 +284,7 @@ DESCRIPTION Set a context as current ``` -_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/config/context/use.ts)_ +_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/config/context/use.ts)_ ## `asyncapi config versions` @@ -296,7 +301,7 @@ DESCRIPTION Show versions of AsyncAPI tools used ``` -_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/config/versions.ts)_ +_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/config/versions.ts)_ ## `asyncapi convert [SPEC-FILE]` @@ -318,7 +323,7 @@ DESCRIPTION Convert asyncapi documents older to newer versions ``` -_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/convert.ts)_ +_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/convert.ts)_ ## `asyncapi diff OLD NEW` @@ -373,7 +378,7 @@ DESCRIPTION Find diff between two asyncapi files ``` -_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/diff.ts)_ +_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/diff.ts)_ ## `asyncapi generate` @@ -387,7 +392,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/v1.12.0/src/commands/generate/index.ts)_ +_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/generate/index.ts)_ ## `asyncapi generate fromTemplate [ASYNCAPI] [TEMPLATE]` @@ -425,7 +430,7 @@ 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/v1.12.0/src/commands/generate/fromTemplate.ts)_ +_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/generate/fromTemplate.ts)_ ## `asyncapi generate models [LANGUAGE] [FILE]` @@ -511,7 +516,7 @@ DESCRIPTION Generates typed models ``` -_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/generate/models.ts)_ +_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/generate/models.ts)_ ## `asyncapi new` @@ -568,7 +573,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/v1.12.0/src/commands/new/index.ts)_ +_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/new/index.ts)_ ## `asyncapi new file` @@ -625,7 +630,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/file.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/new/file.ts)_ +_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/new/file.ts)_ ## `asyncapi new glee` @@ -647,7 +652,7 @@ DESCRIPTION Creates a new Glee project ``` -_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/new/glee.ts)_ +_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/new/glee.ts)_ ## `asyncapi optimize [SPEC-FILE]` @@ -685,7 +690,7 @@ EXAMPLES $ asyncapi optimize ./asyncapi.yaml --optimization=remove-components --output=terminal --no-tty ``` -_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/optimize.ts)_ +_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/optimize.ts)_ ## `asyncapi start` @@ -699,7 +704,7 @@ DESCRIPTION Start asyncapi studio ``` -_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/start/index.ts)_ +_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/start/index.ts)_ ## `asyncapi start studio` @@ -718,7 +723,7 @@ DESCRIPTION starts a new local instance of Studio ``` -_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/start/studio.ts)_ +_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/start/studio.ts)_ ## `asyncapi validate [SPEC-FILE]` @@ -745,5 +750,5 @@ DESCRIPTION validate asyncapi file ``` -_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v1.12.0/src/commands/validate.ts)_ +_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v1.12.1/src/commands/validate.ts)_ diff --git a/package-lock.json b/package-lock.json index e816a3c166f..ad5570f4065 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@asyncapi/cli", - "version": "1.12.1", + "version": "1.12.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@asyncapi/cli", - "version": "1.12.1", + "version": "1.12.2", "license": "Apache-2.0", "dependencies": { "@asyncapi/avro-schema-parser": "^3.0.22", diff --git a/package.json b/package.json index a1caf18f31d..1f1bb1a0e91 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@asyncapi/cli", "description": "All in one CLI for all AsyncAPI tools", - "version": "1.12.1", + "version": "1.12.2", "author": "@asyncapi", "bin": { "asyncapi": "./bin/run_bin"