From aa1ff87d0676b315b9e0c22adc8af7216d8b1bdd Mon Sep 17 00:00:00 2001 From: Ishita Sati Date: Wed, 14 Jan 2026 15:28:53 +0530 Subject: [PATCH] Update usage.md --- docs/usage.md | 62 +++++++++++++++++++++++++-------------------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/docs/usage.md b/docs/usage.md index 617e31ca..b4a77de9 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -99,7 +99,7 @@ EXAMPLES $ asyncapi autocomplete --refresh-cache ``` -_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.39/src/commands/autocomplete/index.ts)_ +_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/3.2.39/src/commands/autocomplete/index.ts)_ ## `asyncapi bundle` @@ -136,7 +136,7 @@ EXAMPLES $ 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/v5.0.1/src/commands/bundle.ts)_ +_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/bundle.ts)_ ## `asyncapi config` @@ -150,7 +150,7 @@ DESCRIPTION CLI config settings ``` -_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/index.ts)_ +_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/index.ts)_ ## `asyncapi config analytics` @@ -170,7 +170,7 @@ DESCRIPTION Enable or disable analytics for metrics collection ``` -_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/analytics.ts)_ +_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/analytics.ts)_ ## `asyncapi config auth add PATTERN TOKEN` @@ -192,7 +192,7 @@ DESCRIPTION Add an authentication config for resolving $ref files requiring HTTP Authorization. ``` -_See code: [src/commands/config/auth/add.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/auth/add.ts)_ +_See code: [src/commands/config/auth/add.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/auth/add.ts)_ ## `asyncapi config context` @@ -206,7 +206,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/v5.0.1/src/commands/config/context/index.ts)_ +_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/index.ts)_ ## `asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH` @@ -228,7 +228,7 @@ DESCRIPTION Add a context to the store ``` -_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/add.ts)_ +_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/add.ts)_ ## `asyncapi config context current` @@ -245,7 +245,7 @@ DESCRIPTION Shows the current context that is being used ``` -_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/current.ts)_ +_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/current.ts)_ ## `asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH` @@ -266,7 +266,7 @@ DESCRIPTION Edit a context in the store ``` -_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/edit.ts)_ +_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/edit.ts)_ ## `asyncapi config context init [CONTEXT-FILE-PATH]` @@ -289,7 +289,7 @@ DESCRIPTION Initialize context ``` -_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/init.ts)_ +_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/init.ts)_ ## `asyncapi config context list` @@ -306,7 +306,7 @@ DESCRIPTION List all the stored contexts in the store ``` -_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/list.ts)_ +_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/list.ts)_ ## `asyncapi config context remove CONTEXT-NAME` @@ -326,7 +326,7 @@ DESCRIPTION Delete a context from the store ``` -_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/remove.ts)_ +_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/remove.ts)_ ## `asyncapi config context use CONTEXT-NAME` @@ -346,7 +346,7 @@ DESCRIPTION Set a context as current ``` -_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/context/use.ts)_ +_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/context/use.ts)_ ## `asyncapi config versions` @@ -363,7 +363,7 @@ DESCRIPTION Show versions of AsyncAPI tools used ``` -_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/config/versions.ts)_ +_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/config/versions.ts)_ ## `asyncapi convert [SPEC-FILE]` @@ -393,7 +393,7 @@ DESCRIPTION Convert asyncapi documents older to newer versions or OpenAPI/postman-collection documents to AsyncAPI ``` -_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/convert.ts)_ +_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/convert.ts)_ ## `asyncapi diff OLD NEW` @@ -434,7 +434,7 @@ DESCRIPTION Find diff between two asyncapi files ``` -_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/diff.ts)_ +_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/diff.ts)_ ## `asyncapi format [SPEC-FILE]` @@ -457,7 +457,7 @@ DESCRIPTION Convert asyncapi documents from any format to yaml, yml or JSON ``` -_See code: [src/commands/format.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/format.ts)_ +_See code: [src/commands/format.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/format.ts)_ ## `asyncapi generate` @@ -471,7 +471,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/v5.0.1/src/commands/generate/index.ts)_ +_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/generate/index.ts)_ ## `asyncapi generate client LANGUAGE [ASYNCAPI]` @@ -517,7 +517,7 @@ EXAMPLES $ asyncapi generate client javascript asyncapi.yaml --param version=1.0.0 singleFile=true --output ./docs --force-write ``` -_See code: [src/commands/generate/client.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/generate/client.ts)_ +_See code: [src/commands/generate/client.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/generate/client.ts)_ ## `asyncapi generate fromTemplate [ASYNCAPI] [TEMPLATE]` @@ -563,7 +563,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/v5.0.1/src/commands/generate/fromTemplate.ts)_ +_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/generate/fromTemplate.ts)_ ## `asyncapi generate models LANGUAGE FILE` @@ -640,7 +640,7 @@ DESCRIPTION Generates typed models ``` -_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/generate/models.ts)_ +_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/generate/models.ts)_ ## `asyncapi new` @@ -654,7 +654,7 @@ DESCRIPTION Create a new AsyncAPI project, specification files, or templates for clients and applications. ``` -_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/new/index.ts)_ +_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/new/index.ts)_ ## `asyncapi new file` @@ -712,7 +712,7 @@ EXAMPLES $ asyncapi new --file-name=my-asyncapi.yaml --example=default-example.yaml --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/v5.0.1/src/commands/new/file.ts)_ +_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/new/file.ts)_ ## `asyncapi new template` @@ -734,7 +734,7 @@ DESCRIPTION Creates a new template ``` -_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/new/template.ts)_ +_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/new/template.ts)_ ## `asyncapi optimize [SPEC-FILE]` @@ -778,7 +778,7 @@ EXAMPLES $ asyncapi optimize ./asyncapi.yaml --ignore=schema ``` -_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/optimize.ts)_ +_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/optimize.ts)_ ## `asyncapi pretty SPEC-FILE` @@ -803,7 +803,7 @@ EXAMPLES $ asyncapi pretty ./asyncapi.yaml --output formatted-asyncapi.yaml ``` -_See code: [src/commands/pretty.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/pretty.ts)_ +_See code: [src/commands/pretty.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/pretty.ts)_ ## `asyncapi start` @@ -817,7 +817,7 @@ DESCRIPTION Starts AsyncAPI-related services. Currently, it supports launching the AsyncAPI Studio ``` -_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/start/index.ts)_ +_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/start/index.ts)_ ## `asyncapi start api` @@ -837,7 +837,7 @@ DESCRIPTION starts the AsyncAPI server API. ``` -_See code: [src/commands/start/api.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/start/api.ts)_ +_See code: [src/commands/start/api.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/start/api.ts)_ ## `asyncapi start preview SPEC-FILE` @@ -867,7 +867,7 @@ DESCRIPTION allowed. ``` -_See code: [src/commands/start/preview.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/start/preview.ts)_ +_See code: [src/commands/start/preview.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/start/preview.ts)_ ## `asyncapi start studio [SPEC-FILE]` @@ -891,7 +891,7 @@ DESCRIPTION starts a new local instance of Studio ``` -_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/start/studio.ts)_ +_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/start/studio.ts)_ ## `asyncapi validate [SPEC-FILE]` @@ -927,5 +927,5 @@ DESCRIPTION validate asyncapi file ``` -_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v5.0.1/src/commands/validate.ts)_ +_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/master/src/apps/cli/commands/validate.ts)_