1
1
---
2
- title : " Usage"
2
+ title : ' Usage'
3
3
weight : 40
4
4
---
5
5
6
- <!--
6
+ <!--
7
7
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 -
9
9
10
10
* 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.
11
11
* 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.
19
19
-->
20
20
21
21
The AsyncAPI CLI makes it easier to work with AsyncAPI documents.
22
-
23
22
# Usage
24
23
25
24
<!-- usage -->
26
-
27
25
``` sh-session
28
26
$ npm install -g @asyncapi/cli
29
27
$ asyncapi COMMAND
30
28
running command...
31
29
$ 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
33
31
$ asyncapi --help [COMMAND]
34
32
USAGE
35
33
$ asyncapi COMMAND
36
34
...
37
35
```
38
-
39
36
<!-- usagestop -->
40
37
41
38
# Commands
42
39
43
40
<!-- 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 )
70
66
71
67
## ` asyncapi bundle `
72
68
@@ -103,7 +99,7 @@ EXAMPLES
103
99
$ asyncapi bundle ./asyncapi.yaml -o final-asyncapi.yaml --base ../public-api/main.yaml --baseDir ./social-media/comments-service
104
100
```
105
101
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 ) _
107
103
108
104
## ` asyncapi config `
109
105
@@ -117,7 +113,7 @@ DESCRIPTION
117
113
CLI config settings
118
114
```
119
115
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 ) _
121
117
122
118
## ` asyncapi config analytics `
123
119
@@ -137,7 +133,7 @@ DESCRIPTION
137
133
Enable or disable analytics for metrics collection
138
134
```
139
135
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 ) _
141
137
142
138
## ` asyncapi config context `
143
139
@@ -151,7 +147,7 @@ DESCRIPTION
151
147
Manage short aliases for full paths to AsyncAPI documents
152
148
```
153
149
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 ) _
155
151
156
152
## ` asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH `
157
153
@@ -173,7 +169,7 @@ DESCRIPTION
173
169
Add a context to the store
174
170
```
175
171
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 ) _
177
173
178
174
## ` asyncapi config context current `
179
175
@@ -190,7 +186,7 @@ DESCRIPTION
190
186
Shows the current context that is being used
191
187
```
192
188
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 ) _
194
190
195
191
## ` asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH `
196
192
@@ -211,7 +207,7 @@ DESCRIPTION
211
207
Edit a context in the store
212
208
```
213
209
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 ) _
215
211
216
212
## ` asyncapi config context init [CONTEXT-FILE-PATH] `
217
213
@@ -234,7 +230,7 @@ DESCRIPTION
234
230
Initialize context
235
231
```
236
232
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 ) _
238
234
239
235
## ` asyncapi config context list `
240
236
@@ -251,7 +247,7 @@ DESCRIPTION
251
247
List all the stored contexts in the store
252
248
```
253
249
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 ) _
255
251
256
252
## ` asyncapi config context remove CONTEXT-NAME `
257
253
@@ -271,7 +267,7 @@ DESCRIPTION
271
267
Delete a context from the store
272
268
```
273
269
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 ) _
275
271
276
272
## ` asyncapi config context use CONTEXT-NAME `
277
273
@@ -291,7 +287,7 @@ DESCRIPTION
291
287
Set a context as current
292
288
```
293
289
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 ) _
295
291
296
292
## ` asyncapi config versions `
297
293
@@ -308,7 +304,7 @@ DESCRIPTION
308
304
Show versions of AsyncAPI tools used
309
305
```
310
306
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 ) _
312
308
313
309
## ` asyncapi convert [SPEC-FILE] `
314
310
@@ -336,7 +332,7 @@ DESCRIPTION
336
332
Convert asyncapi documents older to newer versions or OpenAPI/postman-collection documents to AsyncAPI
337
333
```
338
334
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 ) _
340
336
341
337
## ` asyncapi diff OLD NEW `
342
338
@@ -376,7 +372,7 @@ DESCRIPTION
376
372
Find diff between two asyncapi files
377
373
```
378
374
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 ) _
380
376
381
377
## ` asyncapi generate `
382
378
@@ -390,7 +386,7 @@ DESCRIPTION
390
386
Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates.
391
387
```
392
388
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 ) _
394
390
395
391
## ` asyncapi generate fromTemplate ASYNCAPI TEMPLATE `
396
392
@@ -435,7 +431,7 @@ EXAMPLES
435
431
$ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write
436
432
```
437
433
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 ) _
439
435
440
436
## ` asyncapi generate models LANGUAGE FILE `
441
437
@@ -506,7 +502,7 @@ DESCRIPTION
506
502
Generates typed models
507
503
```
508
504
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 ) _
510
506
511
507
## ` asyncapi new `
512
508
@@ -564,7 +560,7 @@ EXAMPLES
564
560
$ 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
565
561
```
566
562
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 ) _
568
564
569
565
## ` asyncapi new file `
570
566
@@ -622,7 +618,7 @@ EXAMPLES
622
618
$ 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
623
619
```
624
620
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 ) _
626
622
627
623
## ` asyncapi new glee `
628
624
@@ -644,7 +640,7 @@ DESCRIPTION
644
640
Creates a new Glee project
645
641
```
646
642
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 ) _
648
644
649
645
## ` asyncapi new template `
650
646
@@ -668,7 +664,7 @@ DESCRIPTION
668
664
Creates a new template
669
665
```
670
666
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 ) _
672
668
673
669
## ` asyncapi optimize [SPEC-FILE] `
674
670
@@ -710,21 +706,21 @@ EXAMPLES
710
706
$ asyncapi optimize ./asyncapi.yaml --ignore=schema
711
707
```
712
708
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 ) _
714
710
715
711
## ` asyncapi start `
716
712
713
+ Starts AsyncAPI-related services. Currently, it supports launching the AsyncAPI Studio
714
+
717
715
```
718
716
USAGE
719
717
$ asyncapi start
720
- ```
721
-
722
718
723
719
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
+ ```
727
722
723
+ _ See code: [ src/commands/start/index.ts] ( https://github.com/asyncapi/cli/blob/v2.6.0/src/commands/start/index.ts ) _
728
724
729
725
## ` asyncapi start studio `
730
726
@@ -743,7 +739,7 @@ DESCRIPTION
743
739
starts a new local instance of Studio
744
740
```
745
741
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 ) _
747
743
748
744
## ` asyncapi validate [SPEC-FILE] `
749
745
@@ -773,6 +769,5 @@ DESCRIPTION
773
769
validate asyncapi file
774
770
```
775
771
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 ) _
778
773
<!-- commandsstop -->
0 commit comments