swaggerhub-cli 0.5.0 → 0.6.2
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 +260 -58
- package/oclif.manifest.json +1 -1
- package/package.json +11 -8
- package/src/commands/project/api/add.js +48 -0
- package/src/commands/project/api/remove.js +69 -0
- package/src/commands/project/create.js +77 -0
- package/src/commands/project/delete.js +44 -0
- package/src/commands/project/domain/add.js +48 -0
- package/src/commands/project/domain/remove.js +69 -0
- package/src/commands/project/get.js +51 -0
- package/src/commands/project/list.js +62 -0
- package/src/commands/project/member/list.js +60 -0
- package/src/format-readme.js +38 -0
- package/src/help.js +1 -1
- package/src/requests/project.js +20 -0
- package/src/support/command/parse-input.js +14 -0
- package/src/template-strings/info.js +16 -1
package/README.md
CHANGED
|
@@ -25,7 +25,7 @@ $ npm i -g swaggerhub-cli
|
|
|
25
25
|
The SwaggerHub CLI can be configured through environment variables or through the [`swaggerhub configure`](#swaggerhub-configure) command. The CLI will look for the following environment variables.
|
|
26
26
|
|
|
27
27
|
* `SWAGGERHUB_API_KEY` (required) – **Important: keep this key secure.** This is the SwaggerHub API key the CLI will use for authentication. You can find your API key on the [user settings page](https://app.swaggerhub.com/settings/apiKey) in SwaggerHub.
|
|
28
|
-
* `SWAGGERHUB_URL` (optional, default is `https://api.swaggerhub.com`) – Customers with on-premise installations need to point this to their on-premise API, which is `http(s)://{swaggerhub-host}/v1` (do not append a backslash).
|
|
28
|
+
* `SWAGGERHUB_URL` (optional, default is `https://api.swaggerhub.com`) – Customers with on-premise installations need to point this to their on-premise API, which is `http(s)://{swaggerhub-host}/v1` (do not append a backslash).
|
|
29
29
|
|
|
30
30
|
Alernatively, you can use the `swaggerhub configure` command to create a configuration file for the CLI to use. This command will walk you through the steps to set up the necessary configurations.
|
|
31
31
|
|
|
@@ -37,7 +37,7 @@ $ swaggerhub configure
|
|
|
37
37
|
|
|
38
38
|
Environment variables take precedence over the configuration file created by this command.
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
# Additional configuration for SwaggerHub On-Premise
|
|
41
41
|
|
|
42
42
|
If your SwaggerHub On-Premise instance uses a **self-signed or privately signed SSL certificate**, there are additional steps required to make the SwaggerHub CLI trust this certificate.
|
|
43
43
|
|
|
@@ -117,7 +117,7 @@ USAGE
|
|
|
117
117
|
* [`swaggerhub domain:setdefault OWNER/DOMAIN_NAME/VERSION`](#swaggerhub-domainsetdefault)
|
|
118
118
|
* [`swaggerhub domain:unpublish OWNER/DOMAIN_NAME/VERSION`](#swaggerhub-domainunpublish)
|
|
119
119
|
* [`swaggerhub domain:update OWNER/DOMAIN_NAME/[VERSION]`](#swaggerhub-domainupdate)
|
|
120
|
-
* [`swaggerhub help [COMMAND]`](#swaggerhub-help
|
|
120
|
+
* [`swaggerhub help [COMMAND]`](#swaggerhub-help)
|
|
121
121
|
* [`swaggerhub integration:create OWNER/API_NAME/[VERSION]`](#swaggerhub-integrationcreate)
|
|
122
122
|
* [`swaggerhub integration:delete OWNER/API_NAME/VERSION/INTEGRATION_ID`](#swaggerhub-integrationdelete)
|
|
123
123
|
* [`swaggerhub integration:execute OWNER/API_NAME/VERSION/INTEGRATION_ID`](#swaggerhub-integrationexecute)
|
|
@@ -125,11 +125,20 @@ USAGE
|
|
|
125
125
|
* [`swaggerhub integration:list OWNER/API_NAME/[VERSION]`](#swaggerhub-integrationlist)
|
|
126
126
|
* [`swaggerhub integration:update OWNER/API_NAME/VERSION/INTEGRATION_ID`](#swaggerhub-integrationupdate)
|
|
127
127
|
* [`swaggerhub plugins`](#swaggerhub-plugins)
|
|
128
|
-
* [`swaggerhub plugins:inspect PLUGIN...`](#swaggerhub-pluginsinspect
|
|
129
|
-
* [`swaggerhub plugins:install PLUGIN...`](#swaggerhub-pluginsinstall
|
|
130
|
-
* [`swaggerhub plugins:link PLUGIN`](#swaggerhub-pluginslink
|
|
131
|
-
* [`swaggerhub plugins:uninstall PLUGIN...`](#swaggerhub-pluginsuninstall
|
|
128
|
+
* [`swaggerhub plugins:inspect PLUGIN...`](#swaggerhub-pluginsinspect)
|
|
129
|
+
* [`swaggerhub plugins:install PLUGIN...`](#swaggerhub-pluginsinstall)
|
|
130
|
+
* [`swaggerhub plugins:link PLUGIN`](#swaggerhub-pluginslink)
|
|
131
|
+
* [`swaggerhub plugins:uninstall PLUGIN...`](#swaggerhub-pluginsuninstall)
|
|
132
132
|
* [`swaggerhub plugins:update`](#swaggerhub-pluginsupdate)
|
|
133
|
+
* [`swaggerhub project:api:add OWNER/PROJECT_NAME API`](#swaggerhub-projectapiadd)
|
|
134
|
+
* [`swaggerhub project:api:remove OWNER/PROJECT_NAME API`](#swaggerhub-projectapiremove)
|
|
135
|
+
* [`swaggerhub project:create OWNER/PROJECT_NAME`](#swaggerhub-projectcreate)
|
|
136
|
+
* [`swaggerhub project:delete OWNER/PROJECT_NAME`](#swaggerhub-projectdelete)
|
|
137
|
+
* [`swaggerhub project:domain:add OWNER/PROJECT_NAME DOMAIN`](#swaggerhub-projectdomainadd)
|
|
138
|
+
* [`swaggerhub project:domain:remove OWNER/PROJECT_NAME DOMAIN`](#swaggerhub-projectdomainremove)
|
|
139
|
+
* [`swaggerhub project:get OWNER/PROJECT_NAME`](#swaggerhub-projectget)
|
|
140
|
+
* [`swaggerhub project:list [OWNER]`](#swaggerhub-projectlist)
|
|
141
|
+
* [`swaggerhub project:member:list OWNER/PROJECT_NAME`](#swaggerhub-projectmemberlist)
|
|
133
142
|
|
|
134
143
|
## `swaggerhub api:create`
|
|
135
144
|
|
|
@@ -161,7 +170,7 @@ EXAMPLES
|
|
|
161
170
|
swaggerhub api:create organization/api/1.0.0 --published=publish --setdefault --file api.json
|
|
162
171
|
```
|
|
163
172
|
|
|
164
|
-
_See code: [src/commands/api/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
173
|
+
_See code: [src/commands/api/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/api/create.js)_
|
|
165
174
|
|
|
166
175
|
## `swaggerhub api:delete`
|
|
167
176
|
|
|
@@ -184,7 +193,7 @@ EXAMPLES
|
|
|
184
193
|
swaggerhub api:delete organization/api --force
|
|
185
194
|
```
|
|
186
195
|
|
|
187
|
-
_See code: [src/commands/api/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
196
|
+
_See code: [src/commands/api/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/api/delete.js)_
|
|
188
197
|
|
|
189
198
|
## `swaggerhub api:get`
|
|
190
199
|
|
|
@@ -211,7 +220,7 @@ EXAMPLES
|
|
|
211
220
|
swaggerhub api:get organization/api/1.0.0 --json
|
|
212
221
|
```
|
|
213
222
|
|
|
214
|
-
_See code: [src/commands/api/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
223
|
+
_See code: [src/commands/api/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/api/get.js)_
|
|
215
224
|
|
|
216
225
|
## `swaggerhub api:publish`
|
|
217
226
|
|
|
@@ -231,7 +240,7 @@ EXAMPLE
|
|
|
231
240
|
swaggerhub api:publish organization/api/1.0.0
|
|
232
241
|
```
|
|
233
242
|
|
|
234
|
-
_See code: [src/commands/api/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
243
|
+
_See code: [src/commands/api/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/api/publish.js)_
|
|
235
244
|
|
|
236
245
|
## `swaggerhub api:setdefault`
|
|
237
246
|
|
|
@@ -251,7 +260,7 @@ EXAMPLE
|
|
|
251
260
|
swaggerhub api:setdefault organization/api/2.0.0
|
|
252
261
|
```
|
|
253
262
|
|
|
254
|
-
_See code: [src/commands/api/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
263
|
+
_See code: [src/commands/api/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/api/setdefault.js)_
|
|
255
264
|
|
|
256
265
|
## `swaggerhub api:unpublish`
|
|
257
266
|
|
|
@@ -271,7 +280,7 @@ EXAMPLE
|
|
|
271
280
|
swaggerhub api:unpublish organization/api/1.0.0
|
|
272
281
|
```
|
|
273
282
|
|
|
274
|
-
_See code: [src/commands/api/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
283
|
+
_See code: [src/commands/api/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/api/unpublish.js)_
|
|
275
284
|
|
|
276
285
|
## `swaggerhub api:update`
|
|
277
286
|
|
|
@@ -305,7 +314,7 @@ EXAMPLES
|
|
|
305
314
|
swaggerhub api:update organization/api/1.0.0 --visibility=private
|
|
306
315
|
```
|
|
307
316
|
|
|
308
|
-
_See code: [src/commands/api/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
317
|
+
_See code: [src/commands/api/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/api/update.js)_
|
|
309
318
|
|
|
310
319
|
## `swaggerhub api:validate`
|
|
311
320
|
|
|
@@ -330,7 +339,7 @@ EXAMPLES
|
|
|
330
339
|
swaggerhub api:validate organization/api
|
|
331
340
|
```
|
|
332
341
|
|
|
333
|
-
_See code: [src/commands/api/validate.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
342
|
+
_See code: [src/commands/api/validate.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/api/validate.js)_
|
|
334
343
|
|
|
335
344
|
## `swaggerhub configure`
|
|
336
345
|
|
|
@@ -352,7 +361,7 @@ DESCRIPTION
|
|
|
352
361
|
settings.
|
|
353
362
|
```
|
|
354
363
|
|
|
355
|
-
_See code: [src/commands/configure.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
364
|
+
_See code: [src/commands/configure.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/configure.js)_
|
|
356
365
|
|
|
357
366
|
## `swaggerhub domain:create`
|
|
358
367
|
|
|
@@ -384,7 +393,7 @@ EXAMPLES
|
|
|
384
393
|
swaggerhub domain:create organization/domain/1.0.0 --publish --setdefault --file domain.json
|
|
385
394
|
```
|
|
386
395
|
|
|
387
|
-
_See code: [src/commands/domain/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
396
|
+
_See code: [src/commands/domain/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/domain/create.js)_
|
|
388
397
|
|
|
389
398
|
## `swaggerhub domain:delete`
|
|
390
399
|
|
|
@@ -407,7 +416,7 @@ EXAMPLES
|
|
|
407
416
|
swaggerhub domain:delete organization/domain --force
|
|
408
417
|
```
|
|
409
418
|
|
|
410
|
-
_See code: [src/commands/domain/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
419
|
+
_See code: [src/commands/domain/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/domain/delete.js)_
|
|
411
420
|
|
|
412
421
|
## `swaggerhub domain:get`
|
|
413
422
|
|
|
@@ -433,7 +442,7 @@ EXAMPLES
|
|
|
433
442
|
swaggerhub domain:get organization/domain/1.0.0 --json
|
|
434
443
|
```
|
|
435
444
|
|
|
436
|
-
_See code: [src/commands/domain/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
445
|
+
_See code: [src/commands/domain/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/domain/get.js)_
|
|
437
446
|
|
|
438
447
|
## `swaggerhub domain:publish`
|
|
439
448
|
|
|
@@ -453,7 +462,7 @@ EXAMPLE
|
|
|
453
462
|
swaggerhub domain:publish organization/domain/1.0.0
|
|
454
463
|
```
|
|
455
464
|
|
|
456
|
-
_See code: [src/commands/domain/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
465
|
+
_See code: [src/commands/domain/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/domain/publish.js)_
|
|
457
466
|
|
|
458
467
|
## `swaggerhub domain:setdefault`
|
|
459
468
|
|
|
@@ -473,7 +482,7 @@ EXAMPLE
|
|
|
473
482
|
swaggerhub domain:setdefault organization/domain/2.0.0
|
|
474
483
|
```
|
|
475
484
|
|
|
476
|
-
_See code: [src/commands/domain/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
485
|
+
_See code: [src/commands/domain/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/domain/setdefault.js)_
|
|
477
486
|
|
|
478
487
|
## `swaggerhub domain:unpublish`
|
|
479
488
|
|
|
@@ -493,7 +502,7 @@ EXAMPLE
|
|
|
493
502
|
swaggerhub domain:unpublish organization/domain/1.0.0
|
|
494
503
|
```
|
|
495
504
|
|
|
496
|
-
_See code: [src/commands/domain/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
505
|
+
_See code: [src/commands/domain/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/domain/unpublish.js)_
|
|
497
506
|
|
|
498
507
|
## `swaggerhub domain:update`
|
|
499
508
|
|
|
@@ -527,9 +536,9 @@ EXAMPLES
|
|
|
527
536
|
swaggerhub domain:update organization/domain/1.0.0 --visibility=private
|
|
528
537
|
```
|
|
529
538
|
|
|
530
|
-
_See code: [src/commands/domain/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
539
|
+
_See code: [src/commands/domain/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/domain/update.js)_
|
|
531
540
|
|
|
532
|
-
## `swaggerhub help
|
|
541
|
+
## `swaggerhub help`
|
|
533
542
|
|
|
534
543
|
display help for swaggerhub
|
|
535
544
|
|
|
@@ -544,7 +553,7 @@ OPTIONS
|
|
|
544
553
|
--all see all commands in CLI
|
|
545
554
|
```
|
|
546
555
|
|
|
547
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.
|
|
556
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.3.1/src/commands/help.ts)_
|
|
548
557
|
|
|
549
558
|
## `swaggerhub integration:create`
|
|
550
559
|
|
|
@@ -570,7 +579,7 @@ EXAMPLE
|
|
|
570
579
|
swaggerhub integration:create organization/api/1.0.0 --file config.json
|
|
571
580
|
```
|
|
572
581
|
|
|
573
|
-
_See code: [src/commands/integration/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
582
|
+
_See code: [src/commands/integration/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/integration/create.js)_
|
|
574
583
|
|
|
575
584
|
## `swaggerhub integration:delete`
|
|
576
585
|
|
|
@@ -590,7 +599,7 @@ EXAMPLE
|
|
|
590
599
|
swaggerhub integration:delete organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
|
|
591
600
|
```
|
|
592
601
|
|
|
593
|
-
_See code: [src/commands/integration/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
602
|
+
_See code: [src/commands/integration/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/integration/delete.js)_
|
|
594
603
|
|
|
595
604
|
## `swaggerhub integration:execute`
|
|
596
605
|
|
|
@@ -610,7 +619,7 @@ EXAMPLE
|
|
|
610
619
|
swaggerhub integration:execute organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
|
|
611
620
|
```
|
|
612
621
|
|
|
613
|
-
_See code: [src/commands/integration/execute.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
622
|
+
_See code: [src/commands/integration/execute.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/integration/execute.js)_
|
|
614
623
|
|
|
615
624
|
## `swaggerhub integration:get`
|
|
616
625
|
|
|
@@ -630,7 +639,7 @@ EXAMPLE
|
|
|
630
639
|
swaggerhub integration:get organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
|
|
631
640
|
```
|
|
632
641
|
|
|
633
|
-
_See code: [src/commands/integration/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
642
|
+
_See code: [src/commands/integration/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/integration/get.js)_
|
|
634
643
|
|
|
635
644
|
## `swaggerhub integration:list`
|
|
636
645
|
|
|
@@ -650,7 +659,7 @@ EXAMPLE
|
|
|
650
659
|
swaggerhub integration:list organization/api/1.0.0
|
|
651
660
|
```
|
|
652
661
|
|
|
653
|
-
_See code: [src/commands/integration/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
662
|
+
_See code: [src/commands/integration/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/integration/list.js)_
|
|
654
663
|
|
|
655
664
|
## `swaggerhub integration:update`
|
|
656
665
|
|
|
@@ -671,60 +680,60 @@ EXAMPLE
|
|
|
671
680
|
swaggerhub integration:update organization/api/1.0.0/503c2db6-448a-4678-abcd-0123456789abc --file config.json
|
|
672
681
|
```
|
|
673
682
|
|
|
674
|
-
_See code: [src/commands/integration/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
683
|
+
_See code: [src/commands/integration/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/integration/update.js)_
|
|
675
684
|
|
|
676
685
|
## `swaggerhub plugins`
|
|
677
686
|
|
|
678
|
-
|
|
687
|
+
List installed plugins.
|
|
679
688
|
|
|
680
689
|
```
|
|
681
690
|
USAGE
|
|
682
691
|
$ swaggerhub plugins
|
|
683
692
|
|
|
684
693
|
OPTIONS
|
|
685
|
-
--core
|
|
694
|
+
--core Show core plugins.
|
|
686
695
|
|
|
687
696
|
EXAMPLE
|
|
688
697
|
$ swaggerhub plugins
|
|
689
698
|
```
|
|
690
699
|
|
|
691
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
700
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/index.ts)_
|
|
692
701
|
|
|
693
|
-
## `swaggerhub plugins:inspect
|
|
702
|
+
## `swaggerhub plugins:inspect`
|
|
694
703
|
|
|
695
|
-
|
|
704
|
+
Displays installation properties of a plugin.
|
|
696
705
|
|
|
697
706
|
```
|
|
698
707
|
USAGE
|
|
699
708
|
$ swaggerhub plugins:inspect PLUGIN...
|
|
700
709
|
|
|
701
710
|
ARGUMENTS
|
|
702
|
-
PLUGIN [default: .]
|
|
711
|
+
PLUGIN [default: .] Plugin to inspect.
|
|
703
712
|
|
|
704
713
|
OPTIONS
|
|
705
|
-
-h, --help
|
|
714
|
+
-h, --help Show CLI help.
|
|
706
715
|
-v, --verbose
|
|
707
716
|
|
|
708
717
|
EXAMPLE
|
|
709
718
|
$ swaggerhub plugins:inspect myplugin
|
|
710
719
|
```
|
|
711
720
|
|
|
712
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
721
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/inspect.ts)_
|
|
713
722
|
|
|
714
|
-
## `swaggerhub plugins:install
|
|
723
|
+
## `swaggerhub plugins:install`
|
|
715
724
|
|
|
716
|
-
|
|
725
|
+
Installs a plugin into the CLI.
|
|
717
726
|
|
|
718
727
|
```
|
|
719
728
|
USAGE
|
|
720
729
|
$ swaggerhub plugins:install PLUGIN...
|
|
721
730
|
|
|
722
731
|
ARGUMENTS
|
|
723
|
-
PLUGIN
|
|
732
|
+
PLUGIN Plugin to install.
|
|
724
733
|
|
|
725
734
|
OPTIONS
|
|
726
|
-
-f, --force yarn install with force flag
|
|
727
|
-
-h, --help
|
|
735
|
+
-f, --force Run yarn install with force flag.
|
|
736
|
+
-h, --help Show CLI help.
|
|
728
737
|
-v, --verbose
|
|
729
738
|
|
|
730
739
|
DESCRIPTION
|
|
@@ -745,11 +754,11 @@ EXAMPLES
|
|
|
745
754
|
$ swaggerhub plugins:install someuser/someplugin
|
|
746
755
|
```
|
|
747
756
|
|
|
748
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
757
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/install.ts)_
|
|
749
758
|
|
|
750
|
-
## `swaggerhub plugins:link
|
|
759
|
+
## `swaggerhub plugins:link`
|
|
751
760
|
|
|
752
|
-
|
|
761
|
+
Links a plugin into the CLI for development.
|
|
753
762
|
|
|
754
763
|
```
|
|
755
764
|
USAGE
|
|
@@ -759,24 +768,24 @@ ARGUMENTS
|
|
|
759
768
|
PATH [default: .] path to plugin
|
|
760
769
|
|
|
761
770
|
OPTIONS
|
|
762
|
-
-h, --help
|
|
771
|
+
-h, --help Show CLI help.
|
|
763
772
|
-v, --verbose
|
|
764
773
|
|
|
765
774
|
DESCRIPTION
|
|
766
775
|
Installation of a linked plugin will override a user-installed or core plugin.
|
|
767
776
|
|
|
768
|
-
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
|
|
769
|
-
|
|
777
|
+
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
|
|
778
|
+
command will override the user-installed or core plugin implementation. This is useful for development work.
|
|
770
779
|
|
|
771
780
|
EXAMPLE
|
|
772
781
|
$ swaggerhub plugins:link myplugin
|
|
773
782
|
```
|
|
774
783
|
|
|
775
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
784
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/link.ts)_
|
|
776
785
|
|
|
777
|
-
## `swaggerhub plugins:uninstall
|
|
786
|
+
## `swaggerhub plugins:uninstall`
|
|
778
787
|
|
|
779
|
-
|
|
788
|
+
Removes a plugin from the CLI.
|
|
780
789
|
|
|
781
790
|
```
|
|
782
791
|
USAGE
|
|
@@ -786,7 +795,7 @@ ARGUMENTS
|
|
|
786
795
|
PLUGIN plugin to uninstall
|
|
787
796
|
|
|
788
797
|
OPTIONS
|
|
789
|
-
-h, --help
|
|
798
|
+
-h, --help Show CLI help.
|
|
790
799
|
-v, --verbose
|
|
791
800
|
|
|
792
801
|
ALIASES
|
|
@@ -794,22 +803,215 @@ ALIASES
|
|
|
794
803
|
$ swaggerhub plugins:remove
|
|
795
804
|
```
|
|
796
805
|
|
|
797
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
806
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/uninstall.ts)_
|
|
798
807
|
|
|
799
808
|
## `swaggerhub plugins:update`
|
|
800
809
|
|
|
801
|
-
|
|
810
|
+
Update installed plugins.
|
|
802
811
|
|
|
803
812
|
```
|
|
804
813
|
USAGE
|
|
805
814
|
$ swaggerhub plugins:update
|
|
806
815
|
|
|
807
816
|
OPTIONS
|
|
808
|
-
-h, --help
|
|
817
|
+
-h, --help Show CLI help.
|
|
809
818
|
-v, --verbose
|
|
810
819
|
```
|
|
811
820
|
|
|
812
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
821
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/update.ts)_
|
|
822
|
+
|
|
823
|
+
## `swaggerhub project:api:add`
|
|
824
|
+
|
|
825
|
+
Adds an API to an existing project.
|
|
826
|
+
|
|
827
|
+
```
|
|
828
|
+
USAGE
|
|
829
|
+
$ swaggerhub project:api:add OWNER/PROJECT_NAME API
|
|
830
|
+
|
|
831
|
+
ARGUMENTS
|
|
832
|
+
OWNER/PROJECT_NAME The project to add the API to
|
|
833
|
+
API The name of the API to add
|
|
834
|
+
|
|
835
|
+
OPTIONS
|
|
836
|
+
-h, --help show CLI help
|
|
837
|
+
|
|
838
|
+
EXAMPLE
|
|
839
|
+
swaggerhub project:api:add organization/project_name my_api
|
|
840
|
+
```
|
|
841
|
+
|
|
842
|
+
_See code: [src/commands/project/api/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/project/api/add.js)_
|
|
843
|
+
|
|
844
|
+
## `swaggerhub project:api:remove`
|
|
845
|
+
|
|
846
|
+
Removes an API from a project in SwaggerHub.
|
|
847
|
+
|
|
848
|
+
```
|
|
849
|
+
USAGE
|
|
850
|
+
$ swaggerhub project:api:remove OWNER/PROJECT_NAME API
|
|
851
|
+
|
|
852
|
+
ARGUMENTS
|
|
853
|
+
OWNER/PROJECT_NAME The project remove the API from
|
|
854
|
+
API The API to remove
|
|
855
|
+
|
|
856
|
+
OPTIONS
|
|
857
|
+
-h, --help show CLI help
|
|
858
|
+
|
|
859
|
+
EXAMPLE
|
|
860
|
+
swaggerhub project:api:remove organization/project_name my_api
|
|
861
|
+
```
|
|
862
|
+
|
|
863
|
+
_See code: [src/commands/project/api/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/project/api/remove.js)_
|
|
864
|
+
|
|
865
|
+
## `swaggerhub project:create`
|
|
866
|
+
|
|
867
|
+
Creates a new project in SwaggerHub.
|
|
868
|
+
|
|
869
|
+
```
|
|
870
|
+
USAGE
|
|
871
|
+
$ swaggerhub project:create OWNER/PROJECT_NAME
|
|
872
|
+
|
|
873
|
+
ARGUMENTS
|
|
874
|
+
OWNER/PROJECT_NAME The new project to create
|
|
875
|
+
|
|
876
|
+
OPTIONS
|
|
877
|
+
-a, --apis=apis Comma separated list of api names to include in project
|
|
878
|
+
-d, --domains=domains Comma separated list of domain names to include in project
|
|
879
|
+
-h, --help show CLI help
|
|
880
|
+
--description=description Description of project
|
|
881
|
+
|
|
882
|
+
EXAMPLES
|
|
883
|
+
swaggerhub project:create organization/new_project_name --description "project description"
|
|
884
|
+
swaggerhub project:create organization/new_project_name -a "testapi1,testapi2"
|
|
885
|
+
swaggerhub project:create organization/new_project_name --apis "testapi1,testapi2"
|
|
886
|
+
swaggerhub project:create organization/new_project_name -d "testdomain3,testdomain4"
|
|
887
|
+
swaggerhub project:create organization/new_project_name --domains "testdomain3,testdomain4"
|
|
888
|
+
swaggerhub project:create organization/new_project_name -a "testapi1" -d "testdomain3" --description "description"
|
|
889
|
+
```
|
|
890
|
+
|
|
891
|
+
_See code: [src/commands/project/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/project/create.js)_
|
|
892
|
+
|
|
893
|
+
## `swaggerhub project:delete`
|
|
894
|
+
|
|
895
|
+
Deletes a project from SwaggerHub.
|
|
896
|
+
|
|
897
|
+
```
|
|
898
|
+
USAGE
|
|
899
|
+
$ swaggerhub project:delete OWNER/PROJECT_NAME
|
|
900
|
+
|
|
901
|
+
ARGUMENTS
|
|
902
|
+
OWNER/PROJECT_NAME Project to delete
|
|
903
|
+
|
|
904
|
+
OPTIONS
|
|
905
|
+
-h, --help show CLI help
|
|
906
|
+
|
|
907
|
+
EXAMPLE
|
|
908
|
+
swaggerhub project:delete organization/project_name
|
|
909
|
+
```
|
|
910
|
+
|
|
911
|
+
_See code: [src/commands/project/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/project/delete.js)_
|
|
912
|
+
|
|
913
|
+
## `swaggerhub project:domain:add`
|
|
914
|
+
|
|
915
|
+
Adds a domain to an existing project.
|
|
916
|
+
|
|
917
|
+
```
|
|
918
|
+
USAGE
|
|
919
|
+
$ swaggerhub project:domain:add OWNER/PROJECT_NAME DOMAIN
|
|
920
|
+
|
|
921
|
+
ARGUMENTS
|
|
922
|
+
OWNER/PROJECT_NAME The project to add the domain to
|
|
923
|
+
DOMAIN The name of the domain to add
|
|
924
|
+
|
|
925
|
+
OPTIONS
|
|
926
|
+
-h, --help show CLI help
|
|
927
|
+
|
|
928
|
+
EXAMPLE
|
|
929
|
+
swaggerhub project:domain:add organization/project_name my_domain
|
|
930
|
+
```
|
|
931
|
+
|
|
932
|
+
_See code: [src/commands/project/domain/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/project/domain/add.js)_
|
|
933
|
+
|
|
934
|
+
## `swaggerhub project:domain:remove`
|
|
935
|
+
|
|
936
|
+
Removes a domain from a project in SwaggerHub.
|
|
937
|
+
|
|
938
|
+
```
|
|
939
|
+
USAGE
|
|
940
|
+
$ swaggerhub project:domain:remove OWNER/PROJECT_NAME DOMAIN
|
|
941
|
+
|
|
942
|
+
ARGUMENTS
|
|
943
|
+
OWNER/PROJECT_NAME The project remove the domain from
|
|
944
|
+
DOMAIN The domain to remove
|
|
945
|
+
|
|
946
|
+
OPTIONS
|
|
947
|
+
-h, --help show CLI help
|
|
948
|
+
|
|
949
|
+
EXAMPLE
|
|
950
|
+
swaggerhub project:domain:remove organization/project_name my_domain
|
|
951
|
+
```
|
|
952
|
+
|
|
953
|
+
_See code: [src/commands/project/domain/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/project/domain/remove.js)_
|
|
954
|
+
|
|
955
|
+
## `swaggerhub project:get`
|
|
956
|
+
|
|
957
|
+
Retrieves the details for a project.
|
|
958
|
+
|
|
959
|
+
```
|
|
960
|
+
USAGE
|
|
961
|
+
$ swaggerhub project:get OWNER/PROJECT_NAME
|
|
962
|
+
|
|
963
|
+
ARGUMENTS
|
|
964
|
+
OWNER/PROJECT_NAME Project to retrieve the details for
|
|
965
|
+
|
|
966
|
+
OPTIONS
|
|
967
|
+
-h, --help show CLI help
|
|
968
|
+
|
|
969
|
+
EXAMPLE
|
|
970
|
+
swaggerhub project:get organization/project_name
|
|
971
|
+
```
|
|
972
|
+
|
|
973
|
+
_See code: [src/commands/project/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/project/get.js)_
|
|
974
|
+
|
|
975
|
+
## `swaggerhub project:list`
|
|
976
|
+
|
|
977
|
+
list projects
|
|
978
|
+
|
|
979
|
+
```
|
|
980
|
+
USAGE
|
|
981
|
+
$ swaggerhub project:list [OWNER]
|
|
982
|
+
|
|
983
|
+
ARGUMENTS
|
|
984
|
+
OWNER Organization to list projects for
|
|
985
|
+
|
|
986
|
+
OPTIONS
|
|
987
|
+
-h, --help show CLI help
|
|
988
|
+
|
|
989
|
+
EXAMPLES
|
|
990
|
+
swaggerhub project:list
|
|
991
|
+
swaggerhub project:list organization
|
|
992
|
+
```
|
|
993
|
+
|
|
994
|
+
_See code: [src/commands/project/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/project/list.js)_
|
|
995
|
+
|
|
996
|
+
## `swaggerhub project:member:list`
|
|
997
|
+
|
|
998
|
+
list members of a project
|
|
999
|
+
|
|
1000
|
+
```
|
|
1001
|
+
USAGE
|
|
1002
|
+
$ swaggerhub project:member:list OWNER/PROJECT_NAME
|
|
1003
|
+
|
|
1004
|
+
ARGUMENTS
|
|
1005
|
+
OWNER/PROJECT_NAME Project to list members of
|
|
1006
|
+
|
|
1007
|
+
OPTIONS
|
|
1008
|
+
-h, --help show CLI help
|
|
1009
|
+
|
|
1010
|
+
EXAMPLE
|
|
1011
|
+
swaggerhub project:member:list organisation/project_name
|
|
1012
|
+
```
|
|
1013
|
+
|
|
1014
|
+
_See code: [src/commands/project/member/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.2/src/commands/project/member/list.js)_
|
|
813
1015
|
<!-- commandsstop -->
|
|
814
1016
|
|
|
815
1017
|
# Plugins
|