Skip to content

Commit edfd3c1

Browse files
authored
chore(release): v2.5.0 (#1531)
1 parent e5806d0 commit edfd3c1

File tree

3 files changed

+31
-30
lines changed

3 files changed

+31
-30
lines changed

docs/usage.md

+28-27
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.4.0 linux-x64 node-v18.20.4
30+
@asyncapi/cli/2.4.1 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.4.0/src/commands/bundle.ts)_
102+
_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v2.4.1/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.4.0/src/commands/config/index.ts)_
116+
_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v2.4.1/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.4.0/src/commands/config/analytics.ts)_
136+
_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v2.4.1/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.4.0/src/commands/config/context/index.ts)_
150+
_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v2.4.1/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.4.0/src/commands/config/context/add.ts)_
172+
_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v2.4.1/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.4.0/src/commands/config/context/current.ts)_
189+
_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v2.4.1/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.4.0/src/commands/config/context/edit.ts)_
210+
_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v2.4.1/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.4.0/src/commands/config/context/init.ts)_
233+
_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v2.4.1/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.4.0/src/commands/config/context/list.ts)_
250+
_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v2.4.1/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.4.0/src/commands/config/context/remove.ts)_
270+
_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v2.4.1/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.4.0/src/commands/config/context/use.ts)_
290+
_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/config/context/use.ts)_
291291

292292
## `asyncapi config versions`
293293

@@ -304,7 +304,7 @@ 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.4.0/src/commands/config/versions.ts)_
307+
_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/config/versions.ts)_
308308

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

@@ -331,7 +331,7 @@ DESCRIPTION
331331
Convert asyncapi documents older to newer versions or OpenAPI documents to AsyncAPI
332332
```
333333

334-
_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/convert.ts)_
334+
_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/convert.ts)_
335335

336336
## `asyncapi diff OLD NEW`
337337

@@ -371,7 +371,7 @@ DESCRIPTION
371371
Find diff between two asyncapi files
372372
```
373373

374-
_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/diff.ts)_
374+
_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/diff.ts)_
375375

376376
## `asyncapi generate`
377377

@@ -385,7 +385,7 @@ DESCRIPTION
385385
Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates.
386386
```
387387

388-
_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/generate/index.ts)_
388+
_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/generate/index.ts)_
389389

390390
## `asyncapi generate fromTemplate ASYNCAPI TEMPLATE`
391391

@@ -395,7 +395,7 @@ Generates whatever you want using templates compatible with AsyncAPI Generator.
395395
USAGE
396396
$ asyncapi generate fromTemplate ASYNCAPI TEMPLATE [-h] [-d <value>...] [--no-interactive] [-i] [--debug] [-n <value>...]
397397
[-o <value>] [--force-write] [-w] [-p <value>...] [--map-base-url <value>] [--registry-url <value>] [--registry-auth
398-
<value>] [--registry-token <value>]
398+
<value>] [--registry-token <value>] [--use-new-generator]
399399
400400
ARGUMENTS
401401
ASYNCAPI - Local path, url or context-name pointing to AsyncAPI file
@@ -421,6 +421,7 @@ FLAGS
421421
username and password
422422
--registry-url=<value> [default: https://registry.npmjs.org] Specifies the URL of the private registry for
423423
fetching templates and dependencies
424+
--use-new-generator Use v2 generator, for generating from newer templates
424425
425426
DESCRIPTION
426427
Generates whatever you want using templates compatible with AsyncAPI Generator.
@@ -429,7 +430,7 @@ EXAMPLES
429430
$ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write
430431
```
431432

432-
_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/generate/fromTemplate.ts)_
433+
_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/generate/fromTemplate.ts)_
433434

434435
## `asyncapi generate models LANGUAGE FILE`
435436

@@ -500,7 +501,7 @@ DESCRIPTION
500501
Generates typed models
501502
```
502503

503-
_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/generate/models.ts)_
504+
_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/generate/models.ts)_
504505

505506
## `asyncapi new`
506507

@@ -558,7 +559,7 @@ EXAMPLES
558559
$ 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
559560
```
560561

561-
_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/new/index.ts)_
562+
_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/new/index.ts)_
562563

563564
## `asyncapi new file`
564565

@@ -616,7 +617,7 @@ EXAMPLES
616617
$ 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
617618
```
618619

619-
_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/new/file.ts)_
620+
_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/new/file.ts)_
620621

621622
## `asyncapi new glee`
622623

@@ -638,7 +639,7 @@ DESCRIPTION
638639
Creates a new Glee project
639640
```
640641

641-
_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/new/glee.ts)_
642+
_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/new/glee.ts)_
642643

643644
## `asyncapi new template`
644645

@@ -662,7 +663,7 @@ DESCRIPTION
662663
Creates a new template
663664
```
664665

665-
_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/new/template.ts)_
666+
_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/new/template.ts)_
666667

667668
## `asyncapi optimize [SPEC-FILE]`
668669

@@ -704,7 +705,7 @@ EXAMPLES
704705
$ asyncapi optimize ./asyncapi.yaml --ignore=schema
705706
```
706707

707-
_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/optimize.ts)_
708+
_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/optimize.ts)_
708709

709710
## `asyncapi start`
710711

@@ -713,7 +714,7 @@ USAGE
713714
$ asyncapi start
714715
```
715716

716-
_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/start/index.ts)_
717+
_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/start/index.ts)_
717718

718719
## `asyncapi start studio`
719720

@@ -732,7 +733,7 @@ DESCRIPTION
732733
starts a new local instance of Studio
733734
```
734735

735-
_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/start/studio.ts)_
736+
_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/start/studio.ts)_
736737

737738
## `asyncapi validate [SPEC-FILE]`
738739

@@ -762,5 +763,5 @@ DESCRIPTION
762763
validate asyncapi file
763764
```
764765

765-
_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/validate.ts)_
766+
_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/validate.ts)_
766767
<!-- 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.4.1",
4+
"version": "2.5.0",
55
"author": "@asyncapi",
66
"bin": {
77
"asyncapi": "./bin/run_bin"

0 commit comments

Comments
 (0)