swaggerhub-cli 0.8.1 → 0.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -16,7 +16,7 @@ The SwaggerHub CLI enables teams to build automation and workflows around Swagge
16
16
  * [Contributing](#contributing)
17
17
  <!-- tocstop -->
18
18
  # Requirements
19
- Node.js 16.x or later.
19
+ Node.js 18.x or later.
20
20
 
21
21
  # Installation
22
22
  ```sh-session
@@ -110,6 +110,7 @@ USAGE
110
110
  * [`swaggerhub api:unpublish OWNER/API_NAME/VERSION`](#swaggerhub-apiunpublish)
111
111
  * [`swaggerhub api:update OWNER/API_NAME/[VERSION]`](#swaggerhub-apiupdate)
112
112
  * [`swaggerhub api:validate OWNER/API_NAME/[VERSION]`](#swaggerhub-apivalidate)
113
+ * [`swaggerhub api:validate:download-rules OWNER`](#swaggerhub-apivalidatedownload)
113
114
  * [`swaggerhub api:validate:local`](#swaggerhub-apivalidatelocal)
114
115
  * [`swaggerhub configure`](#swaggerhub-configure)
115
116
  * [`swaggerhub domain:create OWNER/DOMAIN_NAME/[VERSION]`](#swaggerhub-domaincreate)
@@ -119,7 +120,7 @@ USAGE
119
120
  * [`swaggerhub domain:setdefault OWNER/DOMAIN_NAME/VERSION`](#swaggerhub-domainsetdefault)
120
121
  * [`swaggerhub domain:unpublish OWNER/DOMAIN_NAME/VERSION`](#swaggerhub-domainunpublish)
121
122
  * [`swaggerhub domain:update OWNER/DOMAIN_NAME/[VERSION]`](#swaggerhub-domainupdate)
122
- * [`swaggerhub help [COMMANDS]`](#swaggerhub-help)
123
+ * [`swaggerhub help [COMMAND]`](#swaggerhub-help)
123
124
  * [`swaggerhub integration:create OWNER/API_NAME/[VERSION]`](#swaggerhub-integrationcreate)
124
125
  * [`swaggerhub integration:delete OWNER/API_NAME/VERSION/INTEGRATION_ID`](#swaggerhub-integrationdelete)
125
126
  * [`swaggerhub integration:execute OWNER/API_NAME/VERSION/INTEGRATION_ID`](#swaggerhub-integrationexecute)
@@ -127,13 +128,14 @@ USAGE
127
128
  * [`swaggerhub integration:list OWNER/API_NAME/[VERSION]`](#swaggerhub-integrationlist)
128
129
  * [`swaggerhub integration:update OWNER/API_NAME/VERSION/INTEGRATION_ID`](#swaggerhub-integrationupdate)
129
130
  * [`swaggerhub plugins`](#swaggerhub-plugins)
130
- * [`swaggerhub plugins:install PLUGIN...`](#swaggerhub-pluginsinstall)
131
+ * [`swaggerhub plugins:add PLUGIN`](#swaggerhub-pluginsadd)
131
132
  * [`swaggerhub plugins:inspect PLUGIN...`](#swaggerhub-pluginsinspect)
132
- * [`swaggerhub plugins:install PLUGIN...`](#swaggerhub-pluginsinstall)
133
- * [`swaggerhub plugins:link PLUGIN`](#swaggerhub-pluginslink)
134
- * [`swaggerhub plugins:uninstall PLUGIN...`](#swaggerhub-pluginsuninstall)
135
- * [`swaggerhub plugins:uninstall PLUGIN...`](#swaggerhub-pluginsuninstall)
136
- * [`swaggerhub plugins:uninstall PLUGIN...`](#swaggerhub-pluginsuninstall)
133
+ * [`swaggerhub plugins:install PLUGIN`](#swaggerhub-pluginsinstall)
134
+ * [`swaggerhub plugins:link PATH`](#swaggerhub-pluginslink)
135
+ * [`swaggerhub plugins:remove [PLUGIN]`](#swaggerhub-pluginsremove)
136
+ * [`swaggerhub plugins:reset`](#swaggerhub-pluginsreset)
137
+ * [`swaggerhub plugins:uninstall [PLUGIN]`](#swaggerhub-pluginsuninstall)
138
+ * [`swaggerhub plugins:unlink [PLUGIN]`](#swaggerhub-pluginsunlink)
137
139
  * [`swaggerhub plugins:update`](#swaggerhub-pluginsupdate)
138
140
  * [`swaggerhub project:api:add OWNER/PROJECT_NAME API`](#swaggerhub-projectapiadd)
139
141
  * [`swaggerhub project:api:remove OWNER/PROJECT_NAME API`](#swaggerhub-projectapiremove)
@@ -151,20 +153,20 @@ creates a new API / API version from a YAML/JSON file
151
153
 
152
154
  ```
153
155
  USAGE
154
- $ swaggerhub api:create OWNER/API_NAME/[VERSION] [-h] [--visibility public|private] (--published
155
- publish|unpublish -f <value>) [--setdefault ]
156
+ $ swaggerhub api:create OWNER/API_NAME/[VERSION] [--visibility public|private] (--published publish|unpublish
157
+ -f <value>) [--setdefault ] [-h]
156
158
 
157
159
  ARGUMENTS
158
160
  OWNER/API_NAME/[VERSION] API to create on SwaggerHub
159
161
 
160
162
  FLAGS
161
- -f, --file=<value> (required) file location of API to create
162
- -h, --help Show CLI help.
163
- --published=<option> [default: unpublish] sets the lifecycle setting of the API version
164
- <options: publish|unpublish>
165
- --setdefault sets API version to be the default
166
- --visibility=<option> [default: private] visibility of API in SwaggerHub
167
- <options: public|private>
163
+ -f, --file=<value> (required) file location of API to create
164
+ -h, --help Show CLI help.
165
+ --published=<option> [default: unpublish] sets the lifecycle setting of the API version
166
+ <options: publish|unpublish>
167
+ --setdefault sets API version to be the default
168
+ --visibility=<option> [default: private] visibility of API in SwaggerHub
169
+ <options: public|private>
168
170
 
169
171
  DESCRIPTION
170
172
  creates a new API / API version from a YAML/JSON file
@@ -184,7 +186,7 @@ EXAMPLES
184
186
  $ swaggerhub api:create organization/api/1.0.0 --published=publish --setdefault --file api.json
185
187
  ```
186
188
 
187
- _See code: [src/commands/api/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/api/create.js)_
189
+ _See code: [src/commands/api/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/api/create.js)_
188
190
 
189
191
  ## `swaggerhub api:delete`
190
192
 
@@ -192,7 +194,7 @@ delete an API or API version
192
194
 
193
195
  ```
194
196
  USAGE
195
- $ swaggerhub api:delete OWNER/API_NAME/[VERSION] [-h] [-f]
197
+ $ swaggerhub api:delete OWNER/API_NAME/[VERSION] [-f] [-h]
196
198
 
197
199
  ARGUMENTS
198
200
  OWNER/API_NAME/[VERSION] API to delete on SwaggerHub
@@ -213,7 +215,7 @@ EXAMPLES
213
215
  $ swaggerhub api:delete organization/api --force
214
216
  ```
215
217
 
216
- _See code: [src/commands/api/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/api/delete.js)_
218
+ _See code: [src/commands/api/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/api/delete.js)_
217
219
 
218
220
  ## `swaggerhub api:get`
219
221
 
@@ -221,7 +223,7 @@ fetches an API definition
221
223
 
222
224
  ```
223
225
  USAGE
224
- $ swaggerhub api:get OWNER/API_NAME/[VERSION] [-h] [-j] [-r]
226
+ $ swaggerhub api:get OWNER/API_NAME/[VERSION] [-j] [-r] [-h]
225
227
 
226
228
  ARGUMENTS
227
229
  OWNER/API_NAME/[VERSION] API to fetch from Swaggerhub
@@ -243,7 +245,7 @@ EXAMPLES
243
245
  $ swaggerhub api:get organization/api/1.0.0 --json
244
246
  ```
245
247
 
246
- _See code: [src/commands/api/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/api/get.js)_
248
+ _See code: [src/commands/api/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/api/get.js)_
247
249
 
248
250
  ## `swaggerhub api:publish`
249
251
 
@@ -251,7 +253,7 @@ publish an API version
251
253
 
252
254
  ```
253
255
  USAGE
254
- $ swaggerhub api:publish OWNER/API_NAME/VERSION [-h] [-f]
256
+ $ swaggerhub api:publish OWNER/API_NAME/VERSION [-f] [-h]
255
257
 
256
258
  ARGUMENTS
257
259
  OWNER/API_NAME/VERSION API to publish on Swaggerhub
@@ -269,7 +271,7 @@ EXAMPLES
269
271
  $ swaggerhub api:publish organization/api/1.0.0 --force
270
272
  ```
271
273
 
272
- _See code: [src/commands/api/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/api/publish.js)_
274
+ _See code: [src/commands/api/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/api/publish.js)_
273
275
 
274
276
  ## `swaggerhub api:setdefault`
275
277
 
@@ -292,7 +294,7 @@ EXAMPLES
292
294
  $ swaggerhub api:setdefault organization/api/2.0.0
293
295
  ```
294
296
 
295
- _See code: [src/commands/api/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/api/setdefault.js)_
297
+ _See code: [src/commands/api/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/api/setdefault.js)_
296
298
 
297
299
  ## `swaggerhub api:unpublish`
298
300
 
@@ -315,7 +317,7 @@ EXAMPLES
315
317
  $ swaggerhub api:unpublish organization/api/1.0.0
316
318
  ```
317
319
 
318
- _See code: [src/commands/api/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/api/unpublish.js)_
320
+ _See code: [src/commands/api/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/api/unpublish.js)_
319
321
 
320
322
  ## `swaggerhub api:update`
321
323
 
@@ -323,20 +325,20 @@ update an API
323
325
 
324
326
  ```
325
327
  USAGE
326
- $ swaggerhub api:update OWNER/API_NAME/[VERSION] [-h] [-f <value>] [--visibility public|private] [--published
327
- publish|unpublish] [--setdefault]
328
+ $ swaggerhub api:update OWNER/API_NAME/[VERSION] [-f <value>] [--visibility public|private] [--published
329
+ publish|unpublish] [--setdefault] [-h]
328
330
 
329
331
  ARGUMENTS
330
332
  OWNER/API_NAME/[VERSION] API to update on SwaggerHub
331
333
 
332
334
  FLAGS
333
- -f, --file=<value> file location of API to update
334
- -h, --help Show CLI help.
335
- --published=<option> sets the lifecycle setting of the API version
336
- <options: publish|unpublish>
337
- --setdefault sets API version to be the default
338
- --visibility=<option> visibility of API in SwaggerHub
339
- <options: public|private>
335
+ -f, --file=<value> file location of API to update
336
+ -h, --help Show CLI help.
337
+ --published=<option> sets the lifecycle setting of the API version
338
+ <options: publish|unpublish>
339
+ --setdefault sets API version to be the default
340
+ --visibility=<option> visibility of API in SwaggerHub
341
+ <options: public|private>
340
342
 
341
343
  DESCRIPTION
342
344
  update an API
@@ -359,7 +361,7 @@ EXAMPLES
359
361
  $ swaggerhub api:update organization/api/1.0.0 --visibility=private
360
362
  ```
361
363
 
362
- _See code: [src/commands/api/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/api/update.js)_
364
+ _See code: [src/commands/api/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/api/update.js)_
363
365
 
364
366
  ## `swaggerhub api:validate`
365
367
 
@@ -367,7 +369,7 @@ Get validation result for an API version
367
369
 
368
370
  ```
369
371
  USAGE
370
- $ swaggerhub api:validate OWNER/API_NAME/[VERSION] [-h] [-c] [-j]
372
+ $ swaggerhub api:validate OWNER/API_NAME/[VERSION] [-c] [-j] [-h]
371
373
 
372
374
  ARGUMENTS
373
375
  OWNER/API_NAME/[VERSION] API to fetch validation errors for from Swaggerhub
@@ -393,7 +395,38 @@ EXAMPLES
393
395
  $ swaggerhub api:validate --fail-on-critical --json organization/api
394
396
  ```
395
397
 
396
- _See code: [src/commands/api/validate/index.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/api/validate/index.js)_
398
+ _See code: [src/commands/api/validate/index.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/api/validate/index.js)_
399
+
400
+ ## `swaggerhub api:validate:download-rules`
401
+
402
+ Get existing SwaggerHub's organization standardization ruleset.
403
+
404
+ ```
405
+ USAGE
406
+ $ swaggerhub api:validate:download-rules OWNER [-s] [-d] [-h]
407
+
408
+ ARGUMENTS
409
+ OWNER Which organization standardization rules to fetch from SwaggerHub
410
+
411
+ FLAGS
412
+ -d, --include-disabled-rules Includes disabled rules in fetched organization's ruleset
413
+ -h, --help Show CLI help.
414
+ -s, --include-system-rules Includes system rules in fetched organization's ruleset
415
+
416
+ DESCRIPTION
417
+ Get existing SwaggerHub's organization standardization ruleset.
418
+ Requires organization name argument. An error will occur if provided organization doesn't exist
419
+ or your account is not permitted to access that organization's settings.
420
+ If the flag `-s` or `--include-system-rules` is used, the returned ruleset will also include SwaggerHub system rules.
421
+ If the flag `-d` or `--include-disabled-rules` is used, the returned ruleset will also include disabled custom rules
422
+
423
+ EXAMPLES
424
+ $ swaggerhub api:validate:download-rules myOrg -s
425
+
426
+ $ swaggerhub api:validate:download-rules myOrg --include-disabled-rules -s
427
+ ```
428
+
429
+ _See code: [src/commands/api/validate/download-rules.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/api/validate/download-rules.js)_
397
430
 
398
431
  ## `swaggerhub api:validate:local`
399
432
 
@@ -401,7 +434,7 @@ Runs a scan against a local API definition using the organization's standardizat
401
434
 
402
435
  ```
403
436
  USAGE
404
- $ swaggerhub api:validate:local -f <value> -o <value> [-h] [-c] [-j]
437
+ $ swaggerhub api:validate:local -f <value> -o <value> [-c] [-j] [-h]
405
438
 
406
439
  FLAGS
407
440
  -c, --fail-on-critical Exit with error code 1 if there are critical standardization errors present
@@ -423,7 +456,7 @@ EXAMPLES
423
456
  $ swaggerhub api:validate:local --organization myOrg --file ./my-api/json --fail-on-critical --json
424
457
  ```
425
458
 
426
- _See code: [src/commands/api/validate/local.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/api/validate/local.js)_
459
+ _See code: [src/commands/api/validate/local.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/api/validate/local.js)_
427
460
 
428
461
  ## `swaggerhub configure`
429
462
 
@@ -446,7 +479,7 @@ DESCRIPTION
446
479
  settings.
447
480
  ```
448
481
 
449
- _See code: [src/commands/configure.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/configure.js)_
482
+ _See code: [src/commands/configure.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/configure.js)_
450
483
 
451
484
  ## `swaggerhub domain:create`
452
485
 
@@ -454,20 +487,20 @@ creates a new domain / domain version from a YAML/JSON file
454
487
 
455
488
  ```
456
489
  USAGE
457
- $ swaggerhub domain:create OWNER/DOMAIN_NAME/[VERSION] [-h] [--visibility public|private] (--published
458
- publish|unpublish -f <value>) [--setdefault ]
490
+ $ swaggerhub domain:create OWNER/DOMAIN_NAME/[VERSION] [--visibility public|private] (--published
491
+ publish|unpublish -f <value>) [--setdefault ] [-h]
459
492
 
460
493
  ARGUMENTS
461
494
  OWNER/DOMAIN_NAME/[VERSION] Domain to create on SwaggerHub
462
495
 
463
496
  FLAGS
464
- -f, --file=<value> (required) file location of domain to create
465
- -h, --help Show CLI help.
466
- --published=<option> [default: unpublish] sets the lifecycle setting of the domain version
467
- <options: publish|unpublish>
468
- --setdefault sets domain version to be the default
469
- --visibility=<option> [default: private] visibility of domain in SwaggerHub
470
- <options: public|private>
497
+ -f, --file=<value> (required) file location of domain to create
498
+ -h, --help Show CLI help.
499
+ --published=<option> [default: unpublish] sets the lifecycle setting of the domain version
500
+ <options: publish|unpublish>
501
+ --setdefault sets domain version to be the default
502
+ --visibility=<option> [default: private] visibility of domain in SwaggerHub
503
+ <options: public|private>
471
504
 
472
505
  DESCRIPTION
473
506
  creates a new domain / domain version from a YAML/JSON file
@@ -487,7 +520,7 @@ EXAMPLES
487
520
  $ swaggerhub domain:create organization/domain/1.0.0 --publish --setdefault --file domain.json
488
521
  ```
489
522
 
490
- _See code: [src/commands/domain/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/domain/create.js)_
523
+ _See code: [src/commands/domain/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/domain/create.js)_
491
524
 
492
525
  ## `swaggerhub domain:delete`
493
526
 
@@ -495,7 +528,7 @@ delete a domain or domain version
495
528
 
496
529
  ```
497
530
  USAGE
498
- $ swaggerhub domain:delete OWNER/DOMAIN_NAME/[VERSION] [-h] [-f]
531
+ $ swaggerhub domain:delete OWNER/DOMAIN_NAME/[VERSION] [-f] [-h]
499
532
 
500
533
  ARGUMENTS
501
534
  OWNER/DOMAIN_NAME/[VERSION] Domain to delete on SwaggerHub
@@ -516,7 +549,7 @@ EXAMPLES
516
549
  $ swaggerhub domain:delete organization/domain --force
517
550
  ```
518
551
 
519
- _See code: [src/commands/domain/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/domain/delete.js)_
552
+ _See code: [src/commands/domain/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/domain/delete.js)_
520
553
 
521
554
  ## `swaggerhub domain:get`
522
555
 
@@ -524,7 +557,7 @@ fetches a domain definition
524
557
 
525
558
  ```
526
559
  USAGE
527
- $ swaggerhub domain:get OWNER/DOMAIN_NAME/[VERSION] [-h] [-j]
560
+ $ swaggerhub domain:get OWNER/DOMAIN_NAME/[VERSION] [-j] [-h]
528
561
 
529
562
  ARGUMENTS
530
563
  OWNER/DOMAIN_NAME/[VERSION] Domain to fetch from SwaggerHub
@@ -545,7 +578,7 @@ EXAMPLES
545
578
  $ swaggerhub domain:get organization/domain/1.0.0 --json
546
579
  ```
547
580
 
548
- _See code: [src/commands/domain/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/domain/get.js)_
581
+ _See code: [src/commands/domain/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/domain/get.js)_
549
582
 
550
583
  ## `swaggerhub domain:publish`
551
584
 
@@ -568,7 +601,7 @@ EXAMPLES
568
601
  $ swaggerhub domain:publish organization/domain/1.0.0
569
602
  ```
570
603
 
571
- _See code: [src/commands/domain/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/domain/publish.js)_
604
+ _See code: [src/commands/domain/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/domain/publish.js)_
572
605
 
573
606
  ## `swaggerhub domain:setdefault`
574
607
 
@@ -591,7 +624,7 @@ EXAMPLES
591
624
  $ swaggerhub domain:setdefault organization/domain/2.0.0
592
625
  ```
593
626
 
594
- _See code: [src/commands/domain/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/domain/setdefault.js)_
627
+ _See code: [src/commands/domain/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/domain/setdefault.js)_
595
628
 
596
629
  ## `swaggerhub domain:unpublish`
597
630
 
@@ -614,7 +647,7 @@ EXAMPLES
614
647
  $ swaggerhub domain:unpublish organization/domain/1.0.0
615
648
  ```
616
649
 
617
- _See code: [src/commands/domain/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/domain/unpublish.js)_
650
+ _See code: [src/commands/domain/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/domain/unpublish.js)_
618
651
 
619
652
  ## `swaggerhub domain:update`
620
653
 
@@ -622,20 +655,20 @@ update a domain
622
655
 
623
656
  ```
624
657
  USAGE
625
- $ swaggerhub domain:update OWNER/DOMAIN_NAME/[VERSION] [-h] [-f <value>] [--visibility public|private]
626
- [--published publish|unpublish] [--setdefault]
658
+ $ swaggerhub domain:update OWNER/DOMAIN_NAME/[VERSION] [-f <value>] [--visibility public|private] [--published
659
+ publish|unpublish] [--setdefault] [-h]
627
660
 
628
661
  ARGUMENTS
629
662
  OWNER/DOMAIN_NAME/[VERSION] Domain to update on SwaggerHub
630
663
 
631
664
  FLAGS
632
- -f, --file=<value> file location of domain to update
633
- -h, --help Show CLI help.
634
- --published=<option> sets the lifecycle setting of the domain version
635
- <options: publish|unpublish>
636
- --setdefault sets domain version to be the default
637
- --visibility=<option> visibility of domain in SwaggerHub
638
- <options: public|private>
665
+ -f, --file=<value> file location of domain to update
666
+ -h, --help Show CLI help.
667
+ --published=<option> sets the lifecycle setting of the domain version
668
+ <options: publish|unpublish>
669
+ --setdefault sets domain version to be the default
670
+ --visibility=<option> visibility of domain in SwaggerHub
671
+ <options: public|private>
639
672
 
640
673
  DESCRIPTION
641
674
  update a domain
@@ -658,7 +691,7 @@ EXAMPLES
658
691
  $ swaggerhub domain:update organization/domain/1.0.0 --visibility=private
659
692
  ```
660
693
 
661
- _See code: [src/commands/domain/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/domain/update.js)_
694
+ _See code: [src/commands/domain/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/domain/update.js)_
662
695
 
663
696
  ## `swaggerhub help`
664
697
 
@@ -666,10 +699,10 @@ Display help for swaggerhub.
666
699
 
667
700
  ```
668
701
  USAGE
669
- $ swaggerhub help [COMMANDS] [-n]
702
+ $ swaggerhub help [COMMAND...] [-n]
670
703
 
671
704
  ARGUMENTS
672
- COMMANDS Command to show help for.
705
+ COMMAND... Command to show help for.
673
706
 
674
707
  FLAGS
675
708
  -n, --nested-commands Include all nested commands in the output.
@@ -678,7 +711,7 @@ DESCRIPTION
678
711
  Display help for swaggerhub.
679
712
  ```
680
713
 
681
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.15/src/commands/help.ts)_
714
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.22/src/commands/help.ts)_
682
715
 
683
716
  ## `swaggerhub integration:create`
684
717
 
@@ -706,7 +739,7 @@ EXAMPLES
706
739
  $ swaggerhub integration:create organization/api/1.0.0 --file config.json
707
740
  ```
708
741
 
709
- _See code: [src/commands/integration/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/integration/create.js)_
742
+ _See code: [src/commands/integration/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/integration/create.js)_
710
743
 
711
744
  ## `swaggerhub integration:delete`
712
745
 
@@ -729,7 +762,7 @@ EXAMPLES
729
762
  $ swaggerhub integration:delete organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
730
763
  ```
731
764
 
732
- _See code: [src/commands/integration/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/integration/delete.js)_
765
+ _See code: [src/commands/integration/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/integration/delete.js)_
733
766
 
734
767
  ## `swaggerhub integration:execute`
735
768
 
@@ -752,7 +785,7 @@ EXAMPLES
752
785
  $ swaggerhub integration:execute organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
753
786
  ```
754
787
 
755
- _See code: [src/commands/integration/execute.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/integration/execute.js)_
788
+ _See code: [src/commands/integration/execute.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/integration/execute.js)_
756
789
 
757
790
  ## `swaggerhub integration:get`
758
791
 
@@ -775,7 +808,7 @@ EXAMPLES
775
808
  $ swaggerhub integration:get organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
776
809
  ```
777
810
 
778
- _See code: [src/commands/integration/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/integration/get.js)_
811
+ _See code: [src/commands/integration/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/integration/get.js)_
779
812
 
780
813
  ## `swaggerhub integration:list`
781
814
 
@@ -798,7 +831,7 @@ EXAMPLES
798
831
  $ swaggerhub integration:list organization/api/1.0.0
799
832
  ```
800
833
 
801
- _See code: [src/commands/integration/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/integration/list.js)_
834
+ _See code: [src/commands/integration/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/integration/list.js)_
802
835
 
803
836
  ## `swaggerhub integration:update`
804
837
 
@@ -822,7 +855,7 @@ EXAMPLES
822
855
  $ swaggerhub integration:update organization/api/1.0.0/503c2db6-448a-4678-abcd-0123456789abc --file config.json
823
856
  ```
824
857
 
825
- _See code: [src/commands/integration/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/integration/update.js)_
858
+ _See code: [src/commands/integration/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/integration/update.js)_
826
859
 
827
860
  ## `swaggerhub plugins`
828
861
 
@@ -845,44 +878,53 @@ EXAMPLES
845
878
  $ swaggerhub plugins
846
879
  ```
847
880
 
848
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.8/src/commands/plugins/index.ts)_
881
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/index.ts)_
849
882
 
850
- ## `swaggerhub plugins:install`
883
+ ## `swaggerhub plugins:add`
851
884
 
852
- Installs a plugin into the CLI.
885
+ Installs a plugin into swaggerhub.
853
886
 
854
887
  ```
855
888
  USAGE
856
- $ swaggerhub plugins:install PLUGIN...
889
+ $ swaggerhub plugins:add PLUGIN... [--json] [-f] [-h] [-s | -v]
857
890
 
858
891
  ARGUMENTS
859
- PLUGIN Plugin to install.
892
+ PLUGIN... Plugin to install.
860
893
 
861
894
  FLAGS
862
- -f, --force Run yarn install with force flag.
895
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
863
896
  -h, --help Show CLI help.
864
- -v, --verbose
897
+ -s, --silent Silences npm output.
898
+ -v, --verbose Show verbose npm output.
899
+
900
+ GLOBAL FLAGS
901
+ --json Format output as json.
865
902
 
866
903
  DESCRIPTION
867
- Installs a plugin into the CLI.
868
- Can be installed from npm or a git url.
904
+ Installs a plugin into swaggerhub.
869
905
 
870
- Installation of a user-installed plugin will override a core plugin.
906
+ Uses npm to install plugins.
871
907
 
872
- e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
873
- will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
874
- the CLI without the need to patch and update the whole CLI.
908
+ Installation of a user-installed plugin will override a core plugin.
875
909
 
910
+ Use the SWAGGERHUB_NPM_LOG_LEVEL environment variable to set the npm loglevel.
911
+ Use the SWAGGERHUB_NPM_REGISTRY environment variable to set the npm registry.
876
912
 
877
913
  ALIASES
878
914
  $ swaggerhub plugins:add
879
915
 
880
916
  EXAMPLES
881
- $ swaggerhub plugins:install myplugin
917
+ Install a plugin from npm registry.
918
+
919
+ $ swaggerhub plugins:add myplugin
920
+
921
+ Install a plugin from a github url.
882
922
 
883
- $ swaggerhub plugins:install https://github.com/someuser/someplugin
923
+ $ swaggerhub plugins:add https://github.com/someuser/someplugin
884
924
 
885
- $ swaggerhub plugins:install someuser/someplugin
925
+ Install a plugin from a github slug.
926
+
927
+ $ swaggerhub plugins:add someuser/someplugin
886
928
  ```
887
929
 
888
930
  ## `swaggerhub plugins:inspect`
@@ -894,7 +936,7 @@ USAGE
894
936
  $ swaggerhub plugins:inspect PLUGIN...
895
937
 
896
938
  ARGUMENTS
897
- PLUGIN [default: .] Plugin to inspect.
939
+ PLUGIN... [default: .] Plugin to inspect.
898
940
 
899
941
  FLAGS
900
942
  -h, --help Show CLI help.
@@ -910,47 +952,56 @@ EXAMPLES
910
952
  $ swaggerhub plugins:inspect myplugin
911
953
  ```
912
954
 
913
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.8/src/commands/plugins/inspect.ts)_
955
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/inspect.ts)_
914
956
 
915
957
  ## `swaggerhub plugins:install`
916
958
 
917
- Installs a plugin into the CLI.
959
+ Installs a plugin into swaggerhub.
918
960
 
919
961
  ```
920
962
  USAGE
921
- $ swaggerhub plugins:install PLUGIN...
963
+ $ swaggerhub plugins:install PLUGIN... [--json] [-f] [-h] [-s | -v]
922
964
 
923
965
  ARGUMENTS
924
- PLUGIN Plugin to install.
966
+ PLUGIN... Plugin to install.
925
967
 
926
968
  FLAGS
927
- -f, --force Run yarn install with force flag.
969
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
928
970
  -h, --help Show CLI help.
929
- -v, --verbose
971
+ -s, --silent Silences npm output.
972
+ -v, --verbose Show verbose npm output.
973
+
974
+ GLOBAL FLAGS
975
+ --json Format output as json.
930
976
 
931
977
  DESCRIPTION
932
- Installs a plugin into the CLI.
933
- Can be installed from npm or a git url.
978
+ Installs a plugin into swaggerhub.
934
979
 
935
- Installation of a user-installed plugin will override a core plugin.
980
+ Uses npm to install plugins.
936
981
 
937
- e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
938
- will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
939
- the CLI without the need to patch and update the whole CLI.
982
+ Installation of a user-installed plugin will override a core plugin.
940
983
 
984
+ Use the SWAGGERHUB_NPM_LOG_LEVEL environment variable to set the npm loglevel.
985
+ Use the SWAGGERHUB_NPM_REGISTRY environment variable to set the npm registry.
941
986
 
942
987
  ALIASES
943
988
  $ swaggerhub plugins:add
944
989
 
945
990
  EXAMPLES
946
- $ swaggerhub plugins:install myplugin
991
+ Install a plugin from npm registry.
992
+
993
+ $ swaggerhub plugins:install myplugin
994
+
995
+ Install a plugin from a github url.
996
+
997
+ $ swaggerhub plugins:install https://github.com/someuser/someplugin
947
998
 
948
- $ swaggerhub plugins:install https://github.com/someuser/someplugin
999
+ Install a plugin from a github slug.
949
1000
 
950
- $ swaggerhub plugins:install someuser/someplugin
1001
+ $ swaggerhub plugins:install someuser/someplugin
951
1002
  ```
952
1003
 
953
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.8/src/commands/plugins/install.ts)_
1004
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/install.ts)_
954
1005
 
955
1006
  ## `swaggerhub plugins:link`
956
1007
 
@@ -958,17 +1009,19 @@ Links a plugin into the CLI for development.
958
1009
 
959
1010
  ```
960
1011
  USAGE
961
- $ swaggerhub plugins:link PLUGIN
1012
+ $ swaggerhub plugins:link PATH [-h] [--install] [-v]
962
1013
 
963
1014
  ARGUMENTS
964
1015
  PATH [default: .] path to plugin
965
1016
 
966
1017
  FLAGS
967
- -h, --help Show CLI help.
1018
+ -h, --help Show CLI help.
968
1019
  -v, --verbose
1020
+ --[no-]install Install dependencies after linking the plugin.
969
1021
 
970
1022
  DESCRIPTION
971
1023
  Links a plugin into the CLI for development.
1024
+
972
1025
  Installation of a linked plugin will override a user-installed or core plugin.
973
1026
 
974
1027
  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
@@ -979,18 +1032,18 @@ EXAMPLES
979
1032
  $ swaggerhub plugins:link myplugin
980
1033
  ```
981
1034
 
982
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.8/src/commands/plugins/link.ts)_
1035
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/link.ts)_
983
1036
 
984
- ## `swaggerhub plugins:uninstall`
1037
+ ## `swaggerhub plugins:remove`
985
1038
 
986
1039
  Removes a plugin from the CLI.
987
1040
 
988
1041
  ```
989
1042
  USAGE
990
- $ swaggerhub plugins:uninstall PLUGIN...
1043
+ $ swaggerhub plugins:remove [PLUGIN...] [-h] [-v]
991
1044
 
992
1045
  ARGUMENTS
993
- PLUGIN plugin to uninstall
1046
+ PLUGIN... plugin to uninstall
994
1047
 
995
1048
  FLAGS
996
1049
  -h, --help Show CLI help.
@@ -1002,18 +1055,36 @@ DESCRIPTION
1002
1055
  ALIASES
1003
1056
  $ swaggerhub plugins:unlink
1004
1057
  $ swaggerhub plugins:remove
1058
+
1059
+ EXAMPLES
1060
+ $ swaggerhub plugins:remove myplugin
1005
1061
  ```
1006
1062
 
1063
+ ## `swaggerhub plugins:reset`
1064
+
1065
+ Remove all user-installed and linked plugins.
1066
+
1067
+ ```
1068
+ USAGE
1069
+ $ swaggerhub plugins:reset [--hard] [--reinstall]
1070
+
1071
+ FLAGS
1072
+ --hard Delete node_modules and package manager related files in addition to uninstalling plugins.
1073
+ --reinstall Reinstall all plugins after uninstalling.
1074
+ ```
1075
+
1076
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/reset.ts)_
1077
+
1007
1078
  ## `swaggerhub plugins:uninstall`
1008
1079
 
1009
1080
  Removes a plugin from the CLI.
1010
1081
 
1011
1082
  ```
1012
1083
  USAGE
1013
- $ swaggerhub plugins:uninstall PLUGIN...
1084
+ $ swaggerhub plugins:uninstall [PLUGIN...] [-h] [-v]
1014
1085
 
1015
1086
  ARGUMENTS
1016
- PLUGIN plugin to uninstall
1087
+ PLUGIN... plugin to uninstall
1017
1088
 
1018
1089
  FLAGS
1019
1090
  -h, --help Show CLI help.
@@ -1025,20 +1096,23 @@ DESCRIPTION
1025
1096
  ALIASES
1026
1097
  $ swaggerhub plugins:unlink
1027
1098
  $ swaggerhub plugins:remove
1099
+
1100
+ EXAMPLES
1101
+ $ swaggerhub plugins:uninstall myplugin
1028
1102
  ```
1029
1103
 
1030
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.8/src/commands/plugins/uninstall.ts)_
1104
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/uninstall.ts)_
1031
1105
 
1032
- ## `swaggerhub plugins:uninstall`
1106
+ ## `swaggerhub plugins:unlink`
1033
1107
 
1034
1108
  Removes a plugin from the CLI.
1035
1109
 
1036
1110
  ```
1037
1111
  USAGE
1038
- $ swaggerhub plugins:uninstall PLUGIN...
1112
+ $ swaggerhub plugins:unlink [PLUGIN...] [-h] [-v]
1039
1113
 
1040
1114
  ARGUMENTS
1041
- PLUGIN plugin to uninstall
1115
+ PLUGIN... plugin to uninstall
1042
1116
 
1043
1117
  FLAGS
1044
1118
  -h, --help Show CLI help.
@@ -1050,6 +1124,9 @@ DESCRIPTION
1050
1124
  ALIASES
1051
1125
  $ swaggerhub plugins:unlink
1052
1126
  $ swaggerhub plugins:remove
1127
+
1128
+ EXAMPLES
1129
+ $ swaggerhub plugins:unlink myplugin
1053
1130
  ```
1054
1131
 
1055
1132
  ## `swaggerhub plugins:update`
@@ -1068,7 +1145,7 @@ DESCRIPTION
1068
1145
  Update installed plugins.
1069
1146
  ```
1070
1147
 
1071
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.8/src/commands/plugins/update.ts)_
1148
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.25/src/commands/plugins/update.ts)_
1072
1149
 
1073
1150
  ## `swaggerhub project:api:add`
1074
1151
 
@@ -1092,7 +1169,7 @@ EXAMPLES
1092
1169
  $ swaggerhub project:api:add organization/project_name my_api
1093
1170
  ```
1094
1171
 
1095
- _See code: [src/commands/project/api/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/project/api/add.js)_
1172
+ _See code: [src/commands/project/api/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/project/api/add.js)_
1096
1173
 
1097
1174
  ## `swaggerhub project:api:remove`
1098
1175
 
@@ -1116,7 +1193,7 @@ EXAMPLES
1116
1193
  $ swaggerhub project:api:remove organization/project_name my_api
1117
1194
  ```
1118
1195
 
1119
- _See code: [src/commands/project/api/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/project/api/remove.js)_
1196
+ _See code: [src/commands/project/api/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/project/api/remove.js)_
1120
1197
 
1121
1198
  ## `swaggerhub project:create`
1122
1199
 
@@ -1124,16 +1201,16 @@ Creates a new project in SwaggerHub.
1124
1201
 
1125
1202
  ```
1126
1203
  USAGE
1127
- $ swaggerhub project:create OWNER/PROJECT_NAME [-h] [--description <value>] [-a <value>] [-d <value>]
1204
+ $ swaggerhub project:create OWNER/PROJECT_NAME [--description <value>] [-a <value>] [-d <value>] [-h]
1128
1205
 
1129
1206
  ARGUMENTS
1130
1207
  OWNER/PROJECT_NAME The new project to create on Swaggerhub
1131
1208
 
1132
1209
  FLAGS
1133
- -a, --apis=<value> Comma separated list of api names to include in project
1134
- -d, --domains=<value> Comma separated list of domain names to include in project
1135
- -h, --help Show CLI help.
1136
- --description=<value> Description of project
1210
+ -a, --apis=<value> Comma separated list of api names to include in project
1211
+ -d, --domains=<value> Comma separated list of domain names to include in project
1212
+ -h, --help Show CLI help.
1213
+ --description=<value> Description of project
1137
1214
 
1138
1215
  DESCRIPTION
1139
1216
  Creates a new project in SwaggerHub.
@@ -1152,7 +1229,7 @@ EXAMPLES
1152
1229
  $ swaggerhub project:create organization/new_project_name -a "testapi1" -d "testdomain3" --description "description"
1153
1230
  ```
1154
1231
 
1155
- _See code: [src/commands/project/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/project/create.js)_
1232
+ _See code: [src/commands/project/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/project/create.js)_
1156
1233
 
1157
1234
  ## `swaggerhub project:delete`
1158
1235
 
@@ -1175,7 +1252,7 @@ EXAMPLES
1175
1252
  $ swaggerhub project:delete organization/project_name
1176
1253
  ```
1177
1254
 
1178
- _See code: [src/commands/project/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/project/delete.js)_
1255
+ _See code: [src/commands/project/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/project/delete.js)_
1179
1256
 
1180
1257
  ## `swaggerhub project:domain:add`
1181
1258
 
@@ -1199,7 +1276,7 @@ EXAMPLES
1199
1276
  $ swaggerhub project:domain:add organization/project_name my_domain
1200
1277
  ```
1201
1278
 
1202
- _See code: [src/commands/project/domain/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/project/domain/add.js)_
1279
+ _See code: [src/commands/project/domain/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/project/domain/add.js)_
1203
1280
 
1204
1281
  ## `swaggerhub project:domain:remove`
1205
1282
 
@@ -1223,7 +1300,7 @@ EXAMPLES
1223
1300
  $ swaggerhub project:domain:remove organization/project_name my_domain
1224
1301
  ```
1225
1302
 
1226
- _See code: [src/commands/project/domain/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/project/domain/remove.js)_
1303
+ _See code: [src/commands/project/domain/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/project/domain/remove.js)_
1227
1304
 
1228
1305
  ## `swaggerhub project:get`
1229
1306
 
@@ -1246,7 +1323,7 @@ EXAMPLES
1246
1323
  $ swaggerhub project:get organization/project_name
1247
1324
  ```
1248
1325
 
1249
- _See code: [src/commands/project/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/project/get.js)_
1326
+ _See code: [src/commands/project/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/project/get.js)_
1250
1327
 
1251
1328
  ## `swaggerhub project:list`
1252
1329
 
@@ -1271,7 +1348,7 @@ EXAMPLES
1271
1348
  $ swaggerhub project:list organization
1272
1349
  ```
1273
1350
 
1274
- _See code: [src/commands/project/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/project/list.js)_
1351
+ _See code: [src/commands/project/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/project/list.js)_
1275
1352
 
1276
1353
  ## `swaggerhub project:member:list`
1277
1354
 
@@ -1294,7 +1371,7 @@ EXAMPLES
1294
1371
  $ swaggerhub project:member:list organisation/project_name
1295
1372
  ```
1296
1373
 
1297
- _See code: [src/commands/project/member/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.8.1/src/commands/project/member/list.js)_
1374
+ _See code: [src/commands/project/member/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.1/src/commands/project/member/list.js)_
1298
1375
  <!-- commandsstop -->
1299
1376
 
1300
1377
  # Plugins