Skip to content

Commit 5ffd626

Browse files
authored
chore(release): v2.4.0 (#1525)
1 parent e204457 commit 5ffd626

File tree

3 files changed

+36
-33
lines changed

3 files changed

+36
-33
lines changed

docs/usage.md

Lines changed: 33 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ $ npm install -g @asyncapi/cli
2727
$ asyncapi COMMAND
2828
running command...
2929
$ asyncapi (--version)
30-
@asyncapi/cli/2.3.12 linux-x64 node-v18.20.4
30+
@asyncapi/cli/2.3.13 linux-x64 node-v18.20.4
3131
$ asyncapi --help [COMMAND]
3232
USAGE
3333
$ asyncapi COMMAND
@@ -99,7 +99,7 @@ EXAMPLES
9999
$ asyncapi bundle ./asyncapi.yaml -o final-asyncapi.yaml --base ../public-api/main.yaml --baseDir ./social-media/comments-service
100100
```
101101

102-
_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/bundle.ts)_
102+
_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/bundle.ts)_
103103

104104
## `asyncapi config`
105105

@@ -113,7 +113,7 @@ DESCRIPTION
113113
CLI config settings
114114
```
115115

116-
_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/config/index.ts)_
116+
_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/config/index.ts)_
117117

118118
## `asyncapi config analytics`
119119

@@ -133,7 +133,7 @@ DESCRIPTION
133133
Enable or disable analytics for metrics collection
134134
```
135135

136-
_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/config/analytics.ts)_
136+
_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/config/analytics.ts)_
137137

138138
## `asyncapi config context`
139139

@@ -147,7 +147,7 @@ DESCRIPTION
147147
Manage short aliases for full paths to AsyncAPI documents
148148
```
149149

150-
_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/config/context/index.ts)_
150+
_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/config/context/index.ts)_
151151

152152
## `asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`
153153

@@ -169,7 +169,7 @@ DESCRIPTION
169169
Add a context to the store
170170
```
171171

172-
_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/config/context/add.ts)_
172+
_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/config/context/add.ts)_
173173

174174
## `asyncapi config context current`
175175

@@ -186,7 +186,7 @@ DESCRIPTION
186186
Shows the current context that is being used
187187
```
188188

189-
_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/config/context/current.ts)_
189+
_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/config/context/current.ts)_
190190

191191
## `asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`
192192

@@ -207,7 +207,7 @@ DESCRIPTION
207207
Edit a context in the store
208208
```
209209

210-
_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/config/context/edit.ts)_
210+
_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/config/context/edit.ts)_
211211

212212
## `asyncapi config context init [CONTEXT-FILE-PATH]`
213213

@@ -230,7 +230,7 @@ DESCRIPTION
230230
Initialize context
231231
```
232232

233-
_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/config/context/init.ts)_
233+
_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/config/context/init.ts)_
234234

235235
## `asyncapi config context list`
236236

@@ -247,7 +247,7 @@ DESCRIPTION
247247
List all the stored contexts in the store
248248
```
249249

250-
_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/config/context/list.ts)_
250+
_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/config/context/list.ts)_
251251

252252
## `asyncapi config context remove CONTEXT-NAME`
253253

@@ -267,7 +267,7 @@ DESCRIPTION
267267
Delete a context from the store
268268
```
269269

270-
_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/config/context/remove.ts)_
270+
_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/config/context/remove.ts)_
271271

272272
## `asyncapi config context use CONTEXT-NAME`
273273

@@ -287,7 +287,7 @@ DESCRIPTION
287287
Set a context as current
288288
```
289289

290-
_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/config/context/use.ts)_
290+
_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/config/context/use.ts)_
291291

292292
## `asyncapi config versions`
293293

@@ -304,31 +304,34 @@ DESCRIPTION
304304
Show versions of AsyncAPI tools used
305305
```
306306

307-
_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/config/versions.ts)_
307+
_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/config/versions.ts)_
308308

309309
## `asyncapi convert [SPEC-FILE]`
310310

311-
Convert asyncapi documents older to newer versions or or OpenAPI documents to AsyncAPI
311+
Convert asyncapi documents older to newer versions or OpenAPI documents to AsyncAPI
312312

313313
```
314314
USAGE
315-
$ asyncapi convert [SPEC-FILE] [-h] [-o <value>] [-t <value>] [-p <value>]
315+
$ asyncapi convert [SPEC-FILE] -f openapi|asyncapi [-h] [-o <value>] [-t <value>] [-p client|server]
316316
317317
ARGUMENTS
318318
SPEC-FILE spec path, url, or context-name
319319
320320
FLAGS
321+
-f, --format=<option> (required) [default: asyncapi] Specify the format to convert from (openapi or asyncapi)
322+
<options: openapi|asyncapi>
321323
-h, --help Show CLI help.
322324
-o, --output=<value> path to the file where the result is saved
323-
-p, --perspective=<option> [default: server] Perspective to use when converting OpenAPI to AsyncAPI (client or server). Note: This option is only applicable for OpenAPI to AsyncAPI conversions.
325+
-p, --perspective=<option> [default: server] Perspective to use when converting OpenAPI to AsyncAPI (client or
326+
server). Note: This option is only applicable for OpenAPI to AsyncAPI conversions.
324327
<options: client|server>
325328
-t, --target-version=<value> [default: 3.0.0] asyncapi version to convert to
326329
327330
DESCRIPTION
328-
Convert asyncapi documents older to newer versions or or OpenAPI documents to AsyncAPI
331+
Convert asyncapi documents older to newer versions or OpenAPI documents to AsyncAPI
329332
```
330333

331-
_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/convert.ts)_
334+
_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/convert.ts)_
332335

333336
## `asyncapi diff OLD NEW`
334337

@@ -368,7 +371,7 @@ DESCRIPTION
368371
Find diff between two asyncapi files
369372
```
370373

371-
_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/diff.ts)_
374+
_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/diff.ts)_
372375

373376
## `asyncapi generate`
374377

@@ -382,7 +385,7 @@ DESCRIPTION
382385
Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates.
383386
```
384387

385-
_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/generate/index.ts)_
388+
_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/generate/index.ts)_
386389

387390
## `asyncapi generate fromTemplate ASYNCAPI TEMPLATE`
388391

@@ -426,7 +429,7 @@ EXAMPLES
426429
$ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write
427430
```
428431

429-
_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/generate/fromTemplate.ts)_
432+
_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/generate/fromTemplate.ts)_
430433

431434
## `asyncapi generate models LANGUAGE FILE`
432435

@@ -497,7 +500,7 @@ DESCRIPTION
497500
Generates typed models
498501
```
499502

500-
_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/generate/models.ts)_
503+
_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/generate/models.ts)_
501504

502505
## `asyncapi new`
503506

@@ -555,7 +558,7 @@ EXAMPLES
555558
$ 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
556559
```
557560

558-
_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/new/index.ts)_
561+
_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/new/index.ts)_
559562

560563
## `asyncapi new file`
561564

@@ -613,7 +616,7 @@ EXAMPLES
613616
$ 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
614617
```
615618

616-
_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/new/file.ts)_
619+
_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/new/file.ts)_
617620

618621
## `asyncapi new glee`
619622

@@ -635,7 +638,7 @@ DESCRIPTION
635638
Creates a new Glee project
636639
```
637640

638-
_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/new/glee.ts)_
641+
_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/new/glee.ts)_
639642

640643
## `asyncapi new template`
641644

@@ -659,7 +662,7 @@ DESCRIPTION
659662
Creates a new template
660663
```
661664

662-
_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/new/template.ts)_
665+
_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/new/template.ts)_
663666

664667
## `asyncapi optimize [SPEC-FILE]`
665668

@@ -701,7 +704,7 @@ EXAMPLES
701704
$ asyncapi optimize ./asyncapi.yaml --ignore=schema
702705
```
703706

704-
_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/optimize.ts)_
707+
_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/optimize.ts)_
705708

706709
## `asyncapi start`
707710

@@ -710,7 +713,7 @@ USAGE
710713
$ asyncapi start
711714
```
712715

713-
_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/start/index.ts)_
716+
_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/start/index.ts)_
714717

715718
## `asyncapi start studio`
716719

@@ -729,7 +732,7 @@ DESCRIPTION
729732
starts a new local instance of Studio
730733
```
731734

732-
_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/start/studio.ts)_
735+
_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/start/studio.ts)_
733736

734737
## `asyncapi validate [SPEC-FILE]`
735738

@@ -759,5 +762,5 @@ DESCRIPTION
759762
validate asyncapi file
760763
```
761764

762-
_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.3.12/src/commands/validate.ts)_
765+
_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.3.13/src/commands/validate.ts)_
763766
<!-- commandsstop -->

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
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.3.13",
4+
"version": "2.4.0",
55
"author": "@asyncapi",
66
"bin": {
77
"asyncapi": "./bin/run_bin"

0 commit comments

Comments
 (0)