Skip to content

Commit f2d8fb0

Browse files
authored
chore(release): v2.7.1 (#1551)
1 parent 2e5c6cd commit f2d8fb0

File tree

3 files changed

+61
-66
lines changed

3 files changed

+61
-66
lines changed

docs/usage.md

+58-63
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: "Usage"
2+
title: 'Usage'
33
weight: 40
44
---
55

6-
<!--
6+
<!--
77
8-
This file is automatically generated from updateUsageDocs.js script. In package.json in line 158-161 lines the following steps has been executed in order to run this script successfully -
8+
This file is automatically generated from updateUsageDocs.js script. In package.json in line 158-161 lines the following steps has been executed in order to run this script successfully -
99
1010
* generate:readme:create: It creates the initial content for the README file by printing the usage and commands tags using printf and redirects the output to scripts/README.md file.
1111
* generate:readme:commands: It changes the directory to the scripts folder and executes the oclif readme command. This command generates the usage and commands sections based on the CLI commands and updates the content in the scripts/README.md file.
@@ -19,54 +19,50 @@ This file is automatically generated from updateUsageDocs.js script. In package.
1919
-->
2020

2121
The AsyncAPI CLI makes it easier to work with AsyncAPI documents.
22-
2322
# Usage
2423

2524
<!-- usage -->
26-
2725
```sh-session
2826
$ npm install -g @asyncapi/cli
2927
$ asyncapi COMMAND
3028
running command...
3129
$ asyncapi (--version)
32-
@asyncapi/cli/2.5.0 linux-x64 node-v18.20.4
30+
@asyncapi/cli/2.6.0 linux-x64 node-v18.20.4
3331
$ asyncapi --help [COMMAND]
3432
USAGE
3533
$ asyncapi COMMAND
3634
...
3735
```
38-
3936
<!-- usagestop -->
4037

4138
# Commands
4239

4340
<!-- commands -->
44-
45-
- [`asyncapi bundle`](#asyncapi-bundle)
46-
- [`asyncapi config`](#asyncapi-config)
47-
- [`asyncapi config analytics`](#asyncapi-config-analytics)
48-
- [`asyncapi config context`](#asyncapi-config-context)
49-
- [`asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`](#asyncapi-config-context-add-context-name-spec-file-path)
50-
- [`asyncapi config context current`](#asyncapi-config-context-current)
51-
- [`asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`](#asyncapi-config-context-edit-context-name-new-spec-file-path)
52-
- [`asyncapi config context init [CONTEXT-FILE-PATH]`](#asyncapi-config-context-init-context-file-path)
53-
- [`asyncapi config context list`](#asyncapi-config-context-list)
54-
- [`asyncapi config context remove CONTEXT-NAME`](#asyncapi-config-context-remove-context-name)
55-
- [`asyncapi config context use CONTEXT-NAME`](#asyncapi-config-context-use-context-name)
56-
- [`asyncapi config versions`](#asyncapi-config-versions)
57-
- [`asyncapi convert [SPEC-FILE]`](#asyncapi-convert-spec-file)
58-
- [`asyncapi diff OLD NEW`](#asyncapi-diff-old-new)
59-
- [`asyncapi generate`](#asyncapi-generate)
60-
- [`asyncapi generate fromTemplate ASYNCAPI TEMPLATE`](#asyncapi-generate-fromtemplate-asyncapi-template)
61-
- [`asyncapi generate models LANGUAGE FILE`](#asyncapi-generate-models-language-file)
62-
- [`asyncapi new`](#asyncapi-new)
63-
- [`asyncapi new file`](#asyncapi-new-file)
64-
- [`asyncapi new glee`](#asyncapi-new-glee)
65-
- [`asyncapi new template`](#asyncapi-new-template)
66-
- [`asyncapi optimize [SPEC-FILE]`](#asyncapi-optimize-spec-file)
67-
- [`asyncapi start`](#asyncapi-start)
68-
- [`asyncapi start studio`](#asyncapi-start-studio)
69-
- [`asyncapi validate [SPEC-FILE]`](#asyncapi-validate-spec-file)
41+
* [`asyncapi bundle`](#asyncapi-bundle)
42+
* [`asyncapi config`](#asyncapi-config)
43+
* [`asyncapi config analytics`](#asyncapi-config-analytics)
44+
* [`asyncapi config context`](#asyncapi-config-context)
45+
* [`asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`](#asyncapi-config-context-add-context-name-spec-file-path)
46+
* [`asyncapi config context current`](#asyncapi-config-context-current)
47+
* [`asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`](#asyncapi-config-context-edit-context-name-new-spec-file-path)
48+
* [`asyncapi config context init [CONTEXT-FILE-PATH]`](#asyncapi-config-context-init-context-file-path)
49+
* [`asyncapi config context list`](#asyncapi-config-context-list)
50+
* [`asyncapi config context remove CONTEXT-NAME`](#asyncapi-config-context-remove-context-name)
51+
* [`asyncapi config context use CONTEXT-NAME`](#asyncapi-config-context-use-context-name)
52+
* [`asyncapi config versions`](#asyncapi-config-versions)
53+
* [`asyncapi convert [SPEC-FILE]`](#asyncapi-convert-spec-file)
54+
* [`asyncapi diff OLD NEW`](#asyncapi-diff-old-new)
55+
* [`asyncapi generate`](#asyncapi-generate)
56+
* [`asyncapi generate fromTemplate ASYNCAPI TEMPLATE`](#asyncapi-generate-fromtemplate-asyncapi-template)
57+
* [`asyncapi generate models LANGUAGE FILE`](#asyncapi-generate-models-language-file)
58+
* [`asyncapi new`](#asyncapi-new)
59+
* [`asyncapi new file`](#asyncapi-new-file)
60+
* [`asyncapi new glee`](#asyncapi-new-glee)
61+
* [`asyncapi new template`](#asyncapi-new-template)
62+
* [`asyncapi optimize [SPEC-FILE]`](#asyncapi-optimize-spec-file)
63+
* [`asyncapi start`](#asyncapi-start)
64+
* [`asyncapi start studio`](#asyncapi-start-studio)
65+
* [`asyncapi validate [SPEC-FILE]`](#asyncapi-validate-spec-file)
7066

7167
## `asyncapi bundle`
7268

@@ -103,7 +99,7 @@ EXAMPLES
10399
$ asyncapi bundle ./asyncapi.yaml -o final-asyncapi.yaml --base ../public-api/main.yaml --baseDir ./social-media/comments-service
104100
```
105101

106-
_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/bundle.ts)_
102+
_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/bundle.ts)_
107103

108104
## `asyncapi config`
109105

@@ -117,7 +113,7 @@ DESCRIPTION
117113
CLI config settings
118114
```
119115

120-
_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/index.ts)_
116+
_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/config/index.ts)_
121117

122118
## `asyncapi config analytics`
123119

@@ -137,7 +133,7 @@ DESCRIPTION
137133
Enable or disable analytics for metrics collection
138134
```
139135

140-
_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/analytics.ts)_
136+
_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/config/analytics.ts)_
141137

142138
## `asyncapi config context`
143139

@@ -151,7 +147,7 @@ DESCRIPTION
151147
Manage short aliases for full paths to AsyncAPI documents
152148
```
153149

154-
_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/context/index.ts)_
150+
_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/config/context/index.ts)_
155151

156152
## `asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`
157153

@@ -173,7 +169,7 @@ DESCRIPTION
173169
Add a context to the store
174170
```
175171

176-
_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/context/add.ts)_
172+
_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/config/context/add.ts)_
177173

178174
## `asyncapi config context current`
179175

@@ -190,7 +186,7 @@ DESCRIPTION
190186
Shows the current context that is being used
191187
```
192188

193-
_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/context/current.ts)_
189+
_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/config/context/current.ts)_
194190

195191
## `asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`
196192

@@ -211,7 +207,7 @@ DESCRIPTION
211207
Edit a context in the store
212208
```
213209

214-
_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/context/edit.ts)_
210+
_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/config/context/edit.ts)_
215211

216212
## `asyncapi config context init [CONTEXT-FILE-PATH]`
217213

@@ -234,7 +230,7 @@ DESCRIPTION
234230
Initialize context
235231
```
236232

237-
_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/context/init.ts)_
233+
_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/config/context/init.ts)_
238234

239235
## `asyncapi config context list`
240236

@@ -251,7 +247,7 @@ DESCRIPTION
251247
List all the stored contexts in the store
252248
```
253249

254-
_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/context/list.ts)_
250+
_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/config/context/list.ts)_
255251

256252
## `asyncapi config context remove CONTEXT-NAME`
257253

@@ -271,7 +267,7 @@ DESCRIPTION
271267
Delete a context from the store
272268
```
273269

274-
_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/context/remove.ts)_
270+
_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/config/context/remove.ts)_
275271

276272
## `asyncapi config context use CONTEXT-NAME`
277273

@@ -291,7 +287,7 @@ DESCRIPTION
291287
Set a context as current
292288
```
293289

294-
_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/context/use.ts)_
290+
_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/config/context/use.ts)_
295291

296292
## `asyncapi config versions`
297293

@@ -308,7 +304,7 @@ DESCRIPTION
308304
Show versions of AsyncAPI tools used
309305
```
310306

311-
_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/config/versions.ts)_
307+
_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/config/versions.ts)_
312308

313309
## `asyncapi convert [SPEC-FILE]`
314310

@@ -336,7 +332,7 @@ DESCRIPTION
336332
Convert asyncapi documents older to newer versions or OpenAPI/postman-collection documents to AsyncAPI
337333
```
338334

339-
_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/convert.ts)_
335+
_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/convert.ts)_
340336

341337
## `asyncapi diff OLD NEW`
342338

@@ -376,7 +372,7 @@ DESCRIPTION
376372
Find diff between two asyncapi files
377373
```
378374

379-
_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/diff.ts)_
375+
_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/diff.ts)_
380376

381377
## `asyncapi generate`
382378

@@ -390,7 +386,7 @@ DESCRIPTION
390386
Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates.
391387
```
392388

393-
_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/generate/index.ts)_
389+
_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/generate/index.ts)_
394390

395391
## `asyncapi generate fromTemplate ASYNCAPI TEMPLATE`
396392

@@ -435,7 +431,7 @@ EXAMPLES
435431
$ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write
436432
```
437433

438-
_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/generate/fromTemplate.ts)_
434+
_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/generate/fromTemplate.ts)_
439435

440436
## `asyncapi generate models LANGUAGE FILE`
441437

@@ -506,7 +502,7 @@ DESCRIPTION
506502
Generates typed models
507503
```
508504

509-
_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/generate/models.ts)_
505+
_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/generate/models.ts)_
510506

511507
## `asyncapi new`
512508

@@ -564,7 +560,7 @@ EXAMPLES
564560
$ 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
565561
```
566562

567-
_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/new/index.ts)_
563+
_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/new/index.ts)_
568564

569565
## `asyncapi new file`
570566

@@ -622,7 +618,7 @@ EXAMPLES
622618
$ 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
623619
```
624620

625-
_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/new/file.ts)_
621+
_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/new/file.ts)_
626622

627623
## `asyncapi new glee`
628624

@@ -644,7 +640,7 @@ DESCRIPTION
644640
Creates a new Glee project
645641
```
646642

647-
_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/new/glee.ts)_
643+
_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/new/glee.ts)_
648644

649645
## `asyncapi new template`
650646

@@ -668,7 +664,7 @@ DESCRIPTION
668664
Creates a new template
669665
```
670666

671-
_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/new/template.ts)_
667+
_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/new/template.ts)_
672668

673669
## `asyncapi optimize [SPEC-FILE]`
674670

@@ -710,21 +706,21 @@ EXAMPLES
710706
$ asyncapi optimize ./asyncapi.yaml --ignore=schema
711707
```
712708

713-
_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/optimize.ts)_
709+
_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/optimize.ts)_
714710

715711
## `asyncapi start`
716712

713+
Starts AsyncAPI-related services. Currently, it supports launching the AsyncAPI Studio
714+
717715
```
718716
USAGE
719717
$ asyncapi start
720-
```
721-
722718
723719
DESCRIPTION
724-
main command for starting asyncapi services, currently studio only.
725-
726-
_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/start/index.ts)_
720+
Starts AsyncAPI-related services. Currently, it supports launching the AsyncAPI Studio
721+
```
727722

723+
_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/start/index.ts)_
728724

729725
## `asyncapi start studio`
730726

@@ -743,7 +739,7 @@ DESCRIPTION
743739
starts a new local instance of Studio
744740
```
745741

746-
_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/start/studio.ts)_
742+
_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/start/studio.ts)_
747743

748744
## `asyncapi validate [SPEC-FILE]`
749745

@@ -773,6 +769,5 @@ DESCRIPTION
773769
validate asyncapi file
774770
```
775771

776-
_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.5.0/src/commands/validate.ts)_
777-
772+
_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/validate.ts)_
778773
<!-- commandsstop -->

package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@asyncapi/cli",
33
"description": "All in one CLI for all AsyncAPI tools",
4-
"version": "2.6.0",
4+
"version": "2.7.1",
55
"author": "@asyncapi",
66
"bin": {
77
"asyncapi": "./bin/run_bin"

0 commit comments

Comments
 (0)