Skip to content

Commit 93a0eea

Browse files
author
asyncapi-bot
committed
chore: update generated docs
1 parent 0011ca9 commit 93a0eea

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

docs/usage.md

Lines changed: 29 additions & 29 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.12.0 linux-x64 node-v18.20.5
30+
@asyncapi/cli/2.14.1 linux-x64 node-v18.20.5
3131
$ asyncapi --help [COMMAND]
3232
USAGE
3333
$ asyncapi COMMAND
@@ -101,7 +101,7 @@ EXAMPLES
101101
$ asyncapi bundle ./asyncapi.yaml -o final-asyncapi.yaml --base ../public-api/main.yaml --baseDir ./social-media/comments-service
102102
```
103103

104-
_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/bundle.ts)_
104+
_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/bundle.ts)_
105105

106106
## `asyncapi config`
107107

@@ -115,7 +115,7 @@ DESCRIPTION
115115
CLI config settings
116116
```
117117

118-
_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/index.ts)_
118+
_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/index.ts)_
119119

120120
## `asyncapi config analytics`
121121

@@ -135,7 +135,7 @@ DESCRIPTION
135135
Enable or disable analytics for metrics collection
136136
```
137137

138-
_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/analytics.ts)_
138+
_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/analytics.ts)_
139139

140140
## `asyncapi config context`
141141

@@ -149,7 +149,7 @@ DESCRIPTION
149149
Manage short aliases for full paths to AsyncAPI documents
150150
```
151151

152-
_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/context/index.ts)_
152+
_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/context/index.ts)_
153153

154154
## `asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`
155155

@@ -171,7 +171,7 @@ DESCRIPTION
171171
Add a context to the store
172172
```
173173

174-
_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/context/add.ts)_
174+
_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/context/add.ts)_
175175

176176
## `asyncapi config context current`
177177

@@ -188,7 +188,7 @@ DESCRIPTION
188188
Shows the current context that is being used
189189
```
190190

191-
_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/context/current.ts)_
191+
_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/context/current.ts)_
192192

193193
## `asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`
194194

@@ -209,7 +209,7 @@ DESCRIPTION
209209
Edit a context in the store
210210
```
211211

212-
_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/context/edit.ts)_
212+
_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/context/edit.ts)_
213213

214214
## `asyncapi config context init [CONTEXT-FILE-PATH]`
215215

@@ -232,7 +232,7 @@ DESCRIPTION
232232
Initialize context
233233
```
234234

235-
_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/context/init.ts)_
235+
_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/context/init.ts)_
236236

237237
## `asyncapi config context list`
238238

@@ -249,7 +249,7 @@ DESCRIPTION
249249
List all the stored contexts in the store
250250
```
251251

252-
_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/context/list.ts)_
252+
_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/context/list.ts)_
253253

254254
## `asyncapi config context remove CONTEXT-NAME`
255255

@@ -269,7 +269,7 @@ DESCRIPTION
269269
Delete a context from the store
270270
```
271271

272-
_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/context/remove.ts)_
272+
_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/context/remove.ts)_
273273

274274
## `asyncapi config context use CONTEXT-NAME`
275275

@@ -289,7 +289,7 @@ DESCRIPTION
289289
Set a context as current
290290
```
291291

292-
_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/context/use.ts)_
292+
_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/context/use.ts)_
293293

294294
## `asyncapi config versions`
295295

@@ -306,7 +306,7 @@ DESCRIPTION
306306
Show versions of AsyncAPI tools used
307307
```
308308

309-
_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/versions.ts)_
309+
_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/versions.ts)_
310310

311311
## `asyncapi convert [SPEC-FILE]`
312312

@@ -334,7 +334,7 @@ DESCRIPTION
334334
Convert asyncapi documents older to newer versions or OpenAPI/postman-collection documents to AsyncAPI
335335
```
336336

337-
_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/convert.ts)_
337+
_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/convert.ts)_
338338

339339
## `asyncapi diff OLD NEW`
340340

@@ -375,7 +375,7 @@ DESCRIPTION
375375
Find diff between two asyncapi files
376376
```
377377

378-
_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/diff.ts)_
378+
_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/diff.ts)_
379379

380380
## `asyncapi format [SPEC-FILE]`
381381

@@ -398,7 +398,7 @@ DESCRIPTION
398398
Convert asyncapi documents from any format to yaml, yml or JSON
399399
```
400400

401-
_See code: [src/commands/format.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/format.ts)_
401+
_See code: [src/commands/format.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/format.ts)_
402402

403403
## `asyncapi generate`
404404

@@ -412,7 +412,7 @@ DESCRIPTION
412412
Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates.
413413
```
414414

415-
_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/generate/index.ts)_
415+
_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/generate/index.ts)_
416416

417417
## `asyncapi generate fromTemplate ASYNCAPI TEMPLATE`
418418

@@ -457,7 +457,7 @@ EXAMPLES
457457
$ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write
458458
```
459459

460-
_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/generate/fromTemplate.ts)_
460+
_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/generate/fromTemplate.ts)_
461461

462462
## `asyncapi generate models LANGUAGE FILE`
463463

@@ -527,7 +527,7 @@ DESCRIPTION
527527
Generates typed models
528528
```
529529

530-
_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/generate/models.ts)_
530+
_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/generate/models.ts)_
531531

532532
## `asyncapi new`
533533

@@ -585,7 +585,7 @@ EXAMPLES
585585
$ 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
586586
```
587587

588-
_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/new/index.ts)_
588+
_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/new/index.ts)_
589589

590590
## `asyncapi new file`
591591

@@ -643,7 +643,7 @@ EXAMPLES
643643
$ 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
644644
```
645645

646-
_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/new/file.ts)_
646+
_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/new/file.ts)_
647647

648648
## `asyncapi new glee`
649649

@@ -665,7 +665,7 @@ DESCRIPTION
665665
Creates a new Glee project
666666
```
667667

668-
_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/new/glee.ts)_
668+
_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/new/glee.ts)_
669669

670670
## `asyncapi new template`
671671

@@ -689,7 +689,7 @@ DESCRIPTION
689689
Creates a new template
690690
```
691691

692-
_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/new/template.ts)_
692+
_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/new/template.ts)_
693693

694694
## `asyncapi optimize [SPEC-FILE]`
695695

@@ -731,7 +731,7 @@ EXAMPLES
731731
$ asyncapi optimize ./asyncapi.yaml --ignore=schema
732732
```
733733

734-
_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/optimize.ts)_
734+
_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/optimize.ts)_
735735

736736
## `asyncapi pretty SPEC-FILE`
737737

@@ -748,15 +748,15 @@ FLAGS
748748
-o, --output=<value> Output file path
749749
750750
DESCRIPTION
751-
Format AsyncAPI specification file
751+
Beautify the AsyncAPI spec file (indentation, styling) in place or output the formatted spec to a new file.
752752
753753
EXAMPLES
754754
$ asyncapi pretty ./asyncapi.yaml
755755
756756
$ asyncapi pretty ./asyncapi.yaml --output formatted-asyncapi.yaml
757757
```
758758

759-
_See code: [src/commands/pretty.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/pretty.ts)_
759+
_See code: [src/commands/pretty.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/pretty.ts)_
760760

761761
## `asyncapi start`
762762

@@ -770,7 +770,7 @@ DESCRIPTION
770770
Starts AsyncAPI-related services. Currently, it supports launching the AsyncAPI Studio
771771
```
772772

773-
_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/start/index.ts)_
773+
_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/start/index.ts)_
774774

775775
## `asyncapi start studio`
776776

@@ -789,7 +789,7 @@ DESCRIPTION
789789
starts a new local instance of Studio
790790
```
791791

792-
_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/start/studio.ts)_
792+
_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/start/studio.ts)_
793793

794794
## `asyncapi validate [SPEC-FILE]`
795795

@@ -820,5 +820,5 @@ DESCRIPTION
820820
validate asyncapi file
821821
```
822822

823-
_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/validate.ts)_
823+
_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/validate.ts)_
824824
<!-- commandsstop -->

0 commit comments

Comments
 (0)