@springmicro/cli 0.1.3

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 ADDED
@@ -0,0 +1,1169 @@
1
+ # @springmicro/cli
2
+
3
+ A new CLI generated with oclif.
4
+
5
+ [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
6
+ [![Version](https://img.shields.io/npm/v/@springmicro/cli.svg)](https://npmjs.org/package/@springmicro/cli)
7
+ [![Downloads/week](https://img.shields.io/npm/dw/@springmicro/cli.svg)](https://npmjs.org/package/@springmicro/cli)
8
+
9
+ <!-- toc -->
10
+ * [@springmicro/cli](#springmicrocli)
11
+ * [Usage](#usage)
12
+ * [Commands](#commands)
13
+ <!-- tocstop -->
14
+
15
+ - [Usage](#usage)
16
+ - [Commands](#commands)
17
+ <!-- tocstop -->
18
+ - [Usage](#usage)
19
+ - [Commands](#commands)
20
+ <!-- tocstop -->
21
+
22
+ # Usage
23
+
24
+ <!-- usage -->
25
+ ```sh-session
26
+ $ npm install -g @springmicro/cli
27
+ $ springmicro COMMAND
28
+ running command...
29
+ $ springmicro (--version)
30
+ @springmicro/cli/0.1.3 win32-x64 node-v18.17.1
31
+ $ springmicro --help [COMMAND]
32
+ USAGE
33
+ $ springmicro COMMAND
34
+ ...
35
+ ```
36
+ <!-- usagestop -->
37
+
38
+ ```sh-session
39
+ $ npm install -g @springmicro/cli
40
+ $ springmicro COMMAND
41
+ running command...
42
+ $ springmicro (--version)
43
+ @springmicro/cli/0.1.0 win32-x64 node-v18.17.1
44
+ $ springmicro --help [COMMAND]
45
+ USAGE
46
+ $ springmicro COMMAND
47
+ ...
48
+ ```
49
+
50
+ <!-- usagestop -->
51
+
52
+ ```sh-session
53
+ $ npm install -g @springmicro/cli
54
+ $ springmicro COMMAND
55
+ running command...
56
+ $ springmicro (--version)
57
+ @springmicro/cli/0.0.0 win32-x64 node-v18.17.1
58
+ $ springmicro --help [COMMAND]
59
+ USAGE
60
+ $ springmicro COMMAND
61
+ ...
62
+ ```
63
+
64
+ <!-- usagestop -->
65
+
66
+ # Commands
67
+
68
+ <!-- commands -->
69
+ * [`springmicro help [COMMAND]`](#springmicro-help-command)
70
+ * [`springmicro init PROJECTTYPE`](#springmicro-init-projecttype)
71
+ * [`springmicro init astro`](#springmicro-init-astro)
72
+ * [`springmicro plugins`](#springmicro-plugins)
73
+ * [`springmicro plugins add PLUGIN`](#springmicro-plugins-add-plugin)
74
+ * [`springmicro plugins:inspect PLUGIN...`](#springmicro-pluginsinspect-plugin)
75
+ * [`springmicro plugins install PLUGIN`](#springmicro-plugins-install-plugin)
76
+ * [`springmicro plugins link PATH`](#springmicro-plugins-link-path)
77
+ * [`springmicro plugins remove [PLUGIN]`](#springmicro-plugins-remove-plugin)
78
+ * [`springmicro plugins reset`](#springmicro-plugins-reset)
79
+ * [`springmicro plugins uninstall [PLUGIN]`](#springmicro-plugins-uninstall-plugin)
80
+ * [`springmicro plugins unlink [PLUGIN]`](#springmicro-plugins-unlink-plugin)
81
+ * [`springmicro plugins update`](#springmicro-plugins-update)
82
+
83
+ ## `springmicro help [COMMAND]`
84
+
85
+ Display help for springmicro.
86
+
87
+ ```
88
+ USAGE
89
+ $ springmicro help [COMMAND...] [-n]
90
+
91
+ ARGUMENTS
92
+ COMMAND... Command to show help for.
93
+
94
+ FLAGS
95
+ -n, --nested-commands Include all nested commands in the output.
96
+
97
+ DESCRIPTION
98
+ Display help for springmicro.
99
+ ```
100
+
101
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.0/src/commands/help.ts)_
102
+
103
+ ## `springmicro init PROJECTTYPE`
104
+
105
+ Initialize a JavaScript framework project according to SpringMicroHost's specifications.
106
+
107
+ ```
108
+ USAGE
109
+ $ springmicro init PROJECTTYPE -n <value>
110
+
111
+ ARGUMENTS
112
+ PROJECTTYPE Project type (astro)
113
+
114
+ FLAGS
115
+ -n, --name=<value> (required) Project name
116
+
117
+ DESCRIPTION
118
+ Initialize a JavaScript framework project according to SpringMicroHost's specifications.
119
+
120
+ EXAMPLES
121
+ $ springmicro init astro -n example
122
+ ```
123
+
124
+ _See code: [src/commands/init/index.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.1.3/src/commands/init/index.ts)_
125
+
126
+ ## `springmicro init astro`
127
+
128
+ Initialize a Astro project according to SpringMicroHost's specifications.
129
+
130
+ ```
131
+ USAGE
132
+ $ springmicro init astro -n <value>
133
+
134
+ FLAGS
135
+ -n, --name=<value> (required) Project name
136
+
137
+ DESCRIPTION
138
+ Initialize a Astro project according to SpringMicroHost's specifications.
139
+
140
+ EXAMPLES
141
+ $ springmicro init astro -n <project-name>
142
+ ```
143
+
144
+ _See code: [src/commands/init/astro.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.1.3/src/commands/init/astro.ts)_
145
+
146
+ ## `springmicro plugins`
147
+
148
+ List installed plugins.
149
+
150
+ ```
151
+ USAGE
152
+ $ springmicro plugins [--json] [--core]
153
+
154
+ FLAGS
155
+ --core Show core plugins.
156
+
157
+ GLOBAL FLAGS
158
+ --json Format output as json.
159
+
160
+ DESCRIPTION
161
+ List installed plugins.
162
+
163
+ EXAMPLES
164
+ $ springmicro plugins
165
+ ```
166
+
167
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/index.ts)_
168
+
169
+ ## `springmicro plugins add PLUGIN`
170
+
171
+ Installs a plugin into springmicro.
172
+
173
+ ```
174
+ USAGE
175
+ $ springmicro plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
176
+
177
+ ARGUMENTS
178
+ PLUGIN... Plugin to install.
179
+
180
+ FLAGS
181
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
182
+ -h, --help Show CLI help.
183
+ -s, --silent Silences npm output.
184
+ -v, --verbose Show verbose npm output.
185
+
186
+ GLOBAL FLAGS
187
+ --json Format output as json.
188
+
189
+ DESCRIPTION
190
+ Installs a plugin into springmicro.
191
+
192
+ Uses npm to install plugins.
193
+
194
+ Installation of a user-installed plugin will override a core plugin.
195
+
196
+ Use the SPRINGMICRO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
197
+ Use the SPRINGMICRO_NPM_REGISTRY environment variable to set the npm registry.
198
+
199
+ ALIASES
200
+ $ springmicro plugins add
201
+
202
+ EXAMPLES
203
+ Install a plugin from npm registry.
204
+
205
+ $ springmicro plugins add myplugin
206
+
207
+ Install a plugin from a github url.
208
+
209
+ $ springmicro plugins add https://github.com/someuser/someplugin
210
+
211
+ Install a plugin from a github slug.
212
+
213
+ $ springmicro plugins add someuser/someplugin
214
+ ```
215
+
216
+ ## `springmicro plugins:inspect PLUGIN...`
217
+
218
+ Displays installation properties of a plugin.
219
+
220
+ ```
221
+ USAGE
222
+ $ springmicro plugins inspect PLUGIN...
223
+
224
+ ARGUMENTS
225
+ PLUGIN... [default: .] Plugin to inspect.
226
+
227
+ FLAGS
228
+ -h, --help Show CLI help.
229
+ -v, --verbose
230
+
231
+ GLOBAL FLAGS
232
+ --json Format output as json.
233
+
234
+ DESCRIPTION
235
+ Displays installation properties of a plugin.
236
+
237
+ EXAMPLES
238
+ $ springmicro plugins inspect myplugin
239
+ ```
240
+
241
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/inspect.ts)_
242
+
243
+ ## `springmicro plugins install PLUGIN`
244
+
245
+ Installs a plugin into springmicro.
246
+
247
+ ```
248
+ USAGE
249
+ $ springmicro plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
250
+
251
+ ARGUMENTS
252
+ PLUGIN... Plugin to install.
253
+
254
+ FLAGS
255
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
256
+ -h, --help Show CLI help.
257
+ -s, --silent Silences npm output.
258
+ -v, --verbose Show verbose npm output.
259
+
260
+ GLOBAL FLAGS
261
+ --json Format output as json.
262
+
263
+ DESCRIPTION
264
+ Installs a plugin into springmicro.
265
+
266
+ Uses npm to install plugins.
267
+
268
+ Installation of a user-installed plugin will override a core plugin.
269
+
270
+ Use the SPRINGMICRO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
271
+ Use the SPRINGMICRO_NPM_REGISTRY environment variable to set the npm registry.
272
+
273
+ ALIASES
274
+ $ springmicro plugins add
275
+
276
+ EXAMPLES
277
+ Install a plugin from npm registry.
278
+
279
+ $ springmicro plugins install myplugin
280
+
281
+ Install a plugin from a github url.
282
+
283
+ $ springmicro plugins install https://github.com/someuser/someplugin
284
+
285
+ Install a plugin from a github slug.
286
+
287
+ $ springmicro plugins install someuser/someplugin
288
+ ```
289
+
290
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/install.ts)_
291
+
292
+ ## `springmicro plugins link PATH`
293
+
294
+ Links a plugin into the CLI for development.
295
+
296
+ ```
297
+ USAGE
298
+ $ springmicro plugins link PATH [-h] [--install] [-v]
299
+
300
+ ARGUMENTS
301
+ PATH [default: .] path to plugin
302
+
303
+ FLAGS
304
+ -h, --help Show CLI help.
305
+ -v, --verbose
306
+ --[no-]install Install dependencies after linking the plugin.
307
+
308
+ DESCRIPTION
309
+ Links a plugin into the CLI for development.
310
+ Installation of a linked plugin will override a user-installed or core plugin.
311
+
312
+ e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
313
+ command will override the user-installed or core plugin implementation. This is useful for development work.
314
+
315
+
316
+ EXAMPLES
317
+ $ springmicro plugins link myplugin
318
+ ```
319
+
320
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/link.ts)_
321
+
322
+ ## `springmicro plugins remove [PLUGIN]`
323
+
324
+ Removes a plugin from the CLI.
325
+
326
+ ```
327
+ USAGE
328
+ $ springmicro plugins remove [PLUGIN...] [-h] [-v]
329
+
330
+ ARGUMENTS
331
+ PLUGIN... plugin to uninstall
332
+
333
+ FLAGS
334
+ -h, --help Show CLI help.
335
+ -v, --verbose
336
+
337
+ DESCRIPTION
338
+ Removes a plugin from the CLI.
339
+
340
+ ALIASES
341
+ $ springmicro plugins unlink
342
+ $ springmicro plugins remove
343
+
344
+ EXAMPLES
345
+ $ springmicro plugins remove myplugin
346
+ ```
347
+
348
+ ## `springmicro plugins reset`
349
+
350
+ Remove all user-installed and linked plugins.
351
+
352
+ ```
353
+ USAGE
354
+ $ springmicro plugins reset [--hard] [--reinstall]
355
+
356
+ FLAGS
357
+ --hard Delete node_modules and package manager related files in addition to uninstalling plugins.
358
+ --reinstall Reinstall all plugins after uninstalling.
359
+ ```
360
+
361
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/reset.ts)_
362
+
363
+ ## `springmicro plugins uninstall [PLUGIN]`
364
+
365
+ Removes a plugin from the CLI.
366
+
367
+ ```
368
+ USAGE
369
+ $ springmicro plugins uninstall [PLUGIN...] [-h] [-v]
370
+
371
+ ARGUMENTS
372
+ PLUGIN... plugin to uninstall
373
+
374
+ FLAGS
375
+ -h, --help Show CLI help.
376
+ -v, --verbose
377
+
378
+ DESCRIPTION
379
+ Removes a plugin from the CLI.
380
+
381
+ ALIASES
382
+ $ springmicro plugins unlink
383
+ $ springmicro plugins remove
384
+
385
+ EXAMPLES
386
+ $ springmicro plugins uninstall myplugin
387
+ ```
388
+
389
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/uninstall.ts)_
390
+
391
+ ## `springmicro plugins unlink [PLUGIN]`
392
+
393
+ Removes a plugin from the CLI.
394
+
395
+ ```
396
+ USAGE
397
+ $ springmicro plugins unlink [PLUGIN...] [-h] [-v]
398
+
399
+ ARGUMENTS
400
+ PLUGIN... plugin to uninstall
401
+
402
+ FLAGS
403
+ -h, --help Show CLI help.
404
+ -v, --verbose
405
+
406
+ DESCRIPTION
407
+ Removes a plugin from the CLI.
408
+
409
+ ALIASES
410
+ $ springmicro plugins unlink
411
+ $ springmicro plugins remove
412
+
413
+ EXAMPLES
414
+ $ springmicro plugins unlink myplugin
415
+ ```
416
+
417
+ ## `springmicro plugins update`
418
+
419
+ Update installed plugins.
420
+
421
+ ```
422
+ USAGE
423
+ $ springmicro plugins update [-h] [-v]
424
+
425
+ FLAGS
426
+ -h, --help Show CLI help.
427
+ -v, --verbose
428
+
429
+ DESCRIPTION
430
+ Update installed plugins.
431
+ ```
432
+
433
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/update.ts)_
434
+ <!-- commandsstop -->
435
+
436
+ - [`springmicro help [COMMAND]`](#springmicro-help-command)
437
+ - [`springmicro init PROJECTTYPE`](#springmicro-init-projecttype)
438
+ - [`springmicro init astro`](#springmicro-init-astro)
439
+ - [`springmicro plugins`](#springmicro-plugins)
440
+ - [`springmicro plugins add PLUGIN`](#springmicro-plugins-add-plugin)
441
+ - [`springmicro plugins:inspect PLUGIN...`](#springmicro-pluginsinspect-plugin)
442
+ - [`springmicro plugins install PLUGIN`](#springmicro-plugins-install-plugin)
443
+ - [`springmicro plugins link PATH`](#springmicro-plugins-link-path)
444
+ - [`springmicro plugins remove [PLUGIN]`](#springmicro-plugins-remove-plugin)
445
+ - [`springmicro plugins reset`](#springmicro-plugins-reset)
446
+ - [`springmicro plugins uninstall [PLUGIN]`](#springmicro-plugins-uninstall-plugin)
447
+ - [`springmicro plugins unlink [PLUGIN]`](#springmicro-plugins-unlink-plugin)
448
+ - [`springmicro plugins update`](#springmicro-plugins-update)
449
+
450
+ ## `springmicro help [COMMAND]`
451
+
452
+ Display help for springmicro.
453
+
454
+ ```
455
+ USAGE
456
+ $ springmicro help [COMMAND...] [-n]
457
+
458
+ ARGUMENTS
459
+ COMMAND... Command to show help for.
460
+
461
+ FLAGS
462
+ -n, --nested-commands Include all nested commands in the output.
463
+
464
+ DESCRIPTION
465
+ Display help for springmicro.
466
+ ```
467
+
468
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.0/src/commands/help.ts)_
469
+
470
+ ## `springmicro init PROJECTTYPE`
471
+
472
+ Initialize a JavaScript framework project according to SpringMicroHost's specifications.
473
+
474
+ ```
475
+ USAGE
476
+ $ springmicro init PROJECTTYPE -n <value>
477
+
478
+ ARGUMENTS
479
+ PROJECTTYPE Project type (astro)
480
+
481
+ FLAGS
482
+ -n, --name=<value> (required) Project name
483
+
484
+ DESCRIPTION
485
+ Initialize a JavaScript framework project according to SpringMicroHost's specifications.
486
+
487
+ EXAMPLES
488
+ $ springmicro init astro -n example
489
+ ```
490
+
491
+ _See code: [src/commands/init/index.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.1.0/src/commands/init/index.ts)_
492
+
493
+ ## `springmicro init astro`
494
+
495
+ Initialize a Astro project according to SpringMicroHost's specifications.
496
+
497
+ ```
498
+ USAGE
499
+ $ springmicro init astro -n <value>
500
+
501
+ FLAGS
502
+ -n, --name=<value> (required) Project name
503
+
504
+ DESCRIPTION
505
+ Initialize a Astro project according to SpringMicroHost's specifications.
506
+
507
+ EXAMPLES
508
+ $ springmicro init astro -n <project-name>
509
+ ```
510
+
511
+ _See code: [src/commands/init/astro.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.1.0/src/commands/init/astro.ts)_
512
+
513
+ ## `springmicro plugins`
514
+
515
+ List installed plugins.
516
+
517
+ ```
518
+ USAGE
519
+ $ springmicro plugins [--json] [--core]
520
+
521
+ FLAGS
522
+ --core Show core plugins.
523
+
524
+ GLOBAL FLAGS
525
+ --json Format output as json.
526
+
527
+ DESCRIPTION
528
+ List installed plugins.
529
+
530
+ EXAMPLES
531
+ $ springmicro plugins
532
+ ```
533
+
534
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/index.ts)_
535
+
536
+ ## `springmicro plugins add PLUGIN`
537
+
538
+ Installs a plugin into springmicro.
539
+
540
+ ```
541
+ USAGE
542
+ $ springmicro plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
543
+
544
+ ARGUMENTS
545
+ PLUGIN... Plugin to install.
546
+
547
+ FLAGS
548
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
549
+ -h, --help Show CLI help.
550
+ -s, --silent Silences npm output.
551
+ -v, --verbose Show verbose npm output.
552
+
553
+ GLOBAL FLAGS
554
+ --json Format output as json.
555
+
556
+ DESCRIPTION
557
+ Installs a plugin into springmicro.
558
+
559
+ Uses npm to install plugins.
560
+
561
+ Installation of a user-installed plugin will override a core plugin.
562
+
563
+ Use the SPRINGMICRO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
564
+ Use the SPRINGMICRO_NPM_REGISTRY environment variable to set the npm registry.
565
+
566
+ ALIASES
567
+ $ springmicro plugins add
568
+
569
+ EXAMPLES
570
+ Install a plugin from npm registry.
571
+
572
+ $ springmicro plugins add myplugin
573
+
574
+ Install a plugin from a github url.
575
+
576
+ $ springmicro plugins add https://github.com/someuser/someplugin
577
+
578
+ Install a plugin from a github slug.
579
+
580
+ $ springmicro plugins add someuser/someplugin
581
+ ```
582
+
583
+ ## `springmicro plugins:inspect PLUGIN...`
584
+
585
+ Displays installation properties of a plugin.
586
+
587
+ ```
588
+ USAGE
589
+ $ springmicro plugins inspect PLUGIN...
590
+
591
+ ARGUMENTS
592
+ PLUGIN... [default: .] Plugin to inspect.
593
+
594
+ FLAGS
595
+ -h, --help Show CLI help.
596
+ -v, --verbose
597
+
598
+ GLOBAL FLAGS
599
+ --json Format output as json.
600
+
601
+ DESCRIPTION
602
+ Displays installation properties of a plugin.
603
+
604
+ EXAMPLES
605
+ $ springmicro plugins inspect myplugin
606
+ ```
607
+
608
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/inspect.ts)_
609
+
610
+ ## `springmicro plugins install PLUGIN`
611
+
612
+ Installs a plugin into springmicro.
613
+
614
+ ```
615
+ USAGE
616
+ $ springmicro plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
617
+
618
+ ARGUMENTS
619
+ PLUGIN... Plugin to install.
620
+
621
+ FLAGS
622
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
623
+ -h, --help Show CLI help.
624
+ -s, --silent Silences npm output.
625
+ -v, --verbose Show verbose npm output.
626
+
627
+ GLOBAL FLAGS
628
+ --json Format output as json.
629
+
630
+ DESCRIPTION
631
+ Installs a plugin into springmicro.
632
+
633
+ Uses npm to install plugins.
634
+
635
+ Installation of a user-installed plugin will override a core plugin.
636
+
637
+ Use the SPRINGMICRO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
638
+ Use the SPRINGMICRO_NPM_REGISTRY environment variable to set the npm registry.
639
+
640
+ ALIASES
641
+ $ springmicro plugins add
642
+
643
+ EXAMPLES
644
+ Install a plugin from npm registry.
645
+
646
+ $ springmicro plugins install myplugin
647
+
648
+ Install a plugin from a github url.
649
+
650
+ $ springmicro plugins install https://github.com/someuser/someplugin
651
+
652
+ Install a plugin from a github slug.
653
+
654
+ $ springmicro plugins install someuser/someplugin
655
+ ```
656
+
657
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/install.ts)_
658
+
659
+ ## `springmicro plugins link PATH`
660
+
661
+ Links a plugin into the CLI for development.
662
+
663
+ ```
664
+ USAGE
665
+ $ springmicro plugins link PATH [-h] [--install] [-v]
666
+
667
+ ARGUMENTS
668
+ PATH [default: .] path to plugin
669
+
670
+ FLAGS
671
+ -h, --help Show CLI help.
672
+ -v, --verbose
673
+ --[no-]install Install dependencies after linking the plugin.
674
+
675
+ DESCRIPTION
676
+ Links a plugin into the CLI for development.
677
+ Installation of a linked plugin will override a user-installed or core plugin.
678
+
679
+ e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
680
+ command will override the user-installed or core plugin implementation. This is useful for development work.
681
+
682
+
683
+ EXAMPLES
684
+ $ springmicro plugins link myplugin
685
+ ```
686
+
687
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/link.ts)_
688
+
689
+ ## `springmicro plugins remove [PLUGIN]`
690
+
691
+ Removes a plugin from the CLI.
692
+
693
+ ```
694
+ USAGE
695
+ $ springmicro plugins remove [PLUGIN...] [-h] [-v]
696
+
697
+ ARGUMENTS
698
+ PLUGIN... plugin to uninstall
699
+
700
+ FLAGS
701
+ -h, --help Show CLI help.
702
+ -v, --verbose
703
+
704
+ DESCRIPTION
705
+ Removes a plugin from the CLI.
706
+
707
+ ALIASES
708
+ $ springmicro plugins unlink
709
+ $ springmicro plugins remove
710
+
711
+ EXAMPLES
712
+ $ springmicro plugins remove myplugin
713
+ ```
714
+
715
+ ## `springmicro plugins reset`
716
+
717
+ Remove all user-installed and linked plugins.
718
+
719
+ ```
720
+ USAGE
721
+ $ springmicro plugins reset [--hard] [--reinstall]
722
+
723
+ FLAGS
724
+ --hard Delete node_modules and package manager related files in addition to uninstalling plugins.
725
+ --reinstall Reinstall all plugins after uninstalling.
726
+ ```
727
+
728
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/reset.ts)_
729
+
730
+ ## `springmicro plugins uninstall [PLUGIN]`
731
+
732
+ Removes a plugin from the CLI.
733
+
734
+ ```
735
+ USAGE
736
+ $ springmicro plugins uninstall [PLUGIN...] [-h] [-v]
737
+
738
+ ARGUMENTS
739
+ PLUGIN... plugin to uninstall
740
+
741
+ FLAGS
742
+ -h, --help Show CLI help.
743
+ -v, --verbose
744
+
745
+ DESCRIPTION
746
+ Removes a plugin from the CLI.
747
+
748
+ ALIASES
749
+ $ springmicro plugins unlink
750
+ $ springmicro plugins remove
751
+
752
+ EXAMPLES
753
+ $ springmicro plugins uninstall myplugin
754
+ ```
755
+
756
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/uninstall.ts)_
757
+
758
+ ## `springmicro plugins unlink [PLUGIN]`
759
+
760
+ Removes a plugin from the CLI.
761
+
762
+ ```
763
+ USAGE
764
+ $ springmicro plugins unlink [PLUGIN...] [-h] [-v]
765
+
766
+ ARGUMENTS
767
+ PLUGIN... plugin to uninstall
768
+
769
+ FLAGS
770
+ -h, --help Show CLI help.
771
+ -v, --verbose
772
+
773
+ DESCRIPTION
774
+ Removes a plugin from the CLI.
775
+
776
+ ALIASES
777
+ $ springmicro plugins unlink
778
+ $ springmicro plugins remove
779
+
780
+ EXAMPLES
781
+ $ springmicro plugins unlink myplugin
782
+ ```
783
+
784
+ ## `springmicro plugins update`
785
+
786
+ Update installed plugins.
787
+
788
+ ```
789
+ USAGE
790
+ $ springmicro plugins update [-h] [-v]
791
+
792
+ FLAGS
793
+ -h, --help Show CLI help.
794
+ -v, --verbose
795
+
796
+ DESCRIPTION
797
+ Update installed plugins.
798
+ ```
799
+
800
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/update.ts)_
801
+
802
+ <!-- commandsstop -->
803
+
804
+ - [`springmicro hello PERSON`](#springmicro-hello-person)
805
+ - [`springmicro hello world`](#springmicro-hello-world)
806
+ - [`springmicro help [COMMAND]`](#springmicro-help-command)
807
+ - [`springmicro plugins`](#springmicro-plugins)
808
+ - [`springmicro plugins add PLUGIN`](#springmicro-plugins-add-plugin)
809
+ - [`springmicro plugins:inspect PLUGIN...`](#springmicro-pluginsinspect-plugin)
810
+ - [`springmicro plugins install PLUGIN`](#springmicro-plugins-install-plugin)
811
+ - [`springmicro plugins link PATH`](#springmicro-plugins-link-path)
812
+ - [`springmicro plugins remove [PLUGIN]`](#springmicro-plugins-remove-plugin)
813
+ - [`springmicro plugins reset`](#springmicro-plugins-reset)
814
+ - [`springmicro plugins uninstall [PLUGIN]`](#springmicro-plugins-uninstall-plugin)
815
+ - [`springmicro plugins unlink [PLUGIN]`](#springmicro-plugins-unlink-plugin)
816
+ - [`springmicro plugins update`](#springmicro-plugins-update)
817
+
818
+ ## `springmicro hello PERSON`
819
+
820
+ Say hello
821
+
822
+ ```
823
+ USAGE
824
+ $ springmicro hello PERSON -f <value>
825
+
826
+ ARGUMENTS
827
+ PERSON Person to say hello to
828
+
829
+ FLAGS
830
+ -f, --from=<value> (required) Who is saying hello
831
+
832
+ DESCRIPTION
833
+ Say hello
834
+
835
+ EXAMPLES
836
+ $ springmicro hello friend --from oclif
837
+ hello friend from oclif! (./src/commands/hello/index.ts)
838
+ ```
839
+
840
+ _See code: [src/commands/hello/index.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.0.0/src/commands/hello/index.ts)_
841
+
842
+ ## `springmicro hello world`
843
+
844
+ Say hello world
845
+
846
+ ```
847
+ USAGE
848
+ $ springmicro hello world
849
+
850
+ DESCRIPTION
851
+ Say hello world
852
+
853
+ EXAMPLES
854
+ $ springmicro hello world
855
+ hello world! (./src/commands/hello/world.ts)
856
+ ```
857
+
858
+ _See code: [src/commands/hello/world.ts](https://github.com/SpringMicro1/springmicrohost-js/blob/v0.0.0/src/commands/hello/world.ts)_
859
+
860
+ ## `springmicro help [COMMAND]`
861
+
862
+ Display help for springmicro.
863
+
864
+ ```
865
+ USAGE
866
+ $ springmicro help [COMMAND...] [-n]
867
+
868
+ ARGUMENTS
869
+ COMMAND... Command to show help for.
870
+
871
+ FLAGS
872
+ -n, --nested-commands Include all nested commands in the output.
873
+
874
+ DESCRIPTION
875
+ Display help for springmicro.
876
+ ```
877
+
878
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.0/src/commands/help.ts)_
879
+
880
+ ## `springmicro plugins`
881
+
882
+ List installed plugins.
883
+
884
+ ```
885
+ USAGE
886
+ $ springmicro plugins [--json] [--core]
887
+
888
+ FLAGS
889
+ --core Show core plugins.
890
+
891
+ GLOBAL FLAGS
892
+ --json Format output as json.
893
+
894
+ DESCRIPTION
895
+ List installed plugins.
896
+
897
+ EXAMPLES
898
+ $ springmicro plugins
899
+ ```
900
+
901
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/index.ts)_
902
+
903
+ ## `springmicro plugins add PLUGIN`
904
+
905
+ Installs a plugin into springmicro.
906
+
907
+ ```
908
+ USAGE
909
+ $ springmicro plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
910
+
911
+ ARGUMENTS
912
+ PLUGIN... Plugin to install.
913
+
914
+ FLAGS
915
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
916
+ -h, --help Show CLI help.
917
+ -s, --silent Silences npm output.
918
+ -v, --verbose Show verbose npm output.
919
+
920
+ GLOBAL FLAGS
921
+ --json Format output as json.
922
+
923
+ DESCRIPTION
924
+ Installs a plugin into springmicro.
925
+
926
+ Uses npm to install plugins.
927
+
928
+ Installation of a user-installed plugin will override a core plugin.
929
+
930
+ Use the SPRINGMICRO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
931
+ Use the SPRINGMICRO_NPM_REGISTRY environment variable to set the npm registry.
932
+
933
+ ALIASES
934
+ $ springmicro plugins add
935
+
936
+ EXAMPLES
937
+ Install a plugin from npm registry.
938
+
939
+ $ springmicro plugins add myplugin
940
+
941
+ Install a plugin from a github url.
942
+
943
+ $ springmicro plugins add https://github.com/someuser/someplugin
944
+
945
+ Install a plugin from a github slug.
946
+
947
+ $ springmicro plugins add someuser/someplugin
948
+ ```
949
+
950
+ ## `springmicro plugins:inspect PLUGIN...`
951
+
952
+ Displays installation properties of a plugin.
953
+
954
+ ```
955
+ USAGE
956
+ $ springmicro plugins inspect PLUGIN...
957
+
958
+ ARGUMENTS
959
+ PLUGIN... [default: .] Plugin to inspect.
960
+
961
+ FLAGS
962
+ -h, --help Show CLI help.
963
+ -v, --verbose
964
+
965
+ GLOBAL FLAGS
966
+ --json Format output as json.
967
+
968
+ DESCRIPTION
969
+ Displays installation properties of a plugin.
970
+
971
+ EXAMPLES
972
+ $ springmicro plugins inspect myplugin
973
+ ```
974
+
975
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/inspect.ts)_
976
+
977
+ ## `springmicro plugins install PLUGIN`
978
+
979
+ Installs a plugin into springmicro.
980
+
981
+ ```
982
+ USAGE
983
+ $ springmicro plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
984
+
985
+ ARGUMENTS
986
+ PLUGIN... Plugin to install.
987
+
988
+ FLAGS
989
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
990
+ -h, --help Show CLI help.
991
+ -s, --silent Silences npm output.
992
+ -v, --verbose Show verbose npm output.
993
+
994
+ GLOBAL FLAGS
995
+ --json Format output as json.
996
+
997
+ DESCRIPTION
998
+ Installs a plugin into springmicro.
999
+
1000
+ Uses npm to install plugins.
1001
+
1002
+ Installation of a user-installed plugin will override a core plugin.
1003
+
1004
+ Use the SPRINGMICRO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
1005
+ Use the SPRINGMICRO_NPM_REGISTRY environment variable to set the npm registry.
1006
+
1007
+ ALIASES
1008
+ $ springmicro plugins add
1009
+
1010
+ EXAMPLES
1011
+ Install a plugin from npm registry.
1012
+
1013
+ $ springmicro plugins install myplugin
1014
+
1015
+ Install a plugin from a github url.
1016
+
1017
+ $ springmicro plugins install https://github.com/someuser/someplugin
1018
+
1019
+ Install a plugin from a github slug.
1020
+
1021
+ $ springmicro plugins install someuser/someplugin
1022
+ ```
1023
+
1024
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/install.ts)_
1025
+
1026
+ ## `springmicro plugins link PATH`
1027
+
1028
+ Links a plugin into the CLI for development.
1029
+
1030
+ ```
1031
+ USAGE
1032
+ $ springmicro plugins link PATH [-h] [--install] [-v]
1033
+
1034
+ ARGUMENTS
1035
+ PATH [default: .] path to plugin
1036
+
1037
+ FLAGS
1038
+ -h, --help Show CLI help.
1039
+ -v, --verbose
1040
+ --[no-]install Install dependencies after linking the plugin.
1041
+
1042
+ DESCRIPTION
1043
+ Links a plugin into the CLI for development.
1044
+ Installation of a linked plugin will override a user-installed or core plugin.
1045
+
1046
+ e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
1047
+ command will override the user-installed or core plugin implementation. This is useful for development work.
1048
+
1049
+
1050
+ EXAMPLES
1051
+ $ springmicro plugins link myplugin
1052
+ ```
1053
+
1054
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/link.ts)_
1055
+
1056
+ ## `springmicro plugins remove [PLUGIN]`
1057
+
1058
+ Removes a plugin from the CLI.
1059
+
1060
+ ```
1061
+ USAGE
1062
+ $ springmicro plugins remove [PLUGIN...] [-h] [-v]
1063
+
1064
+ ARGUMENTS
1065
+ PLUGIN... plugin to uninstall
1066
+
1067
+ FLAGS
1068
+ -h, --help Show CLI help.
1069
+ -v, --verbose
1070
+
1071
+ DESCRIPTION
1072
+ Removes a plugin from the CLI.
1073
+
1074
+ ALIASES
1075
+ $ springmicro plugins unlink
1076
+ $ springmicro plugins remove
1077
+
1078
+ EXAMPLES
1079
+ $ springmicro plugins remove myplugin
1080
+ ```
1081
+
1082
+ ## `springmicro plugins reset`
1083
+
1084
+ Remove all user-installed and linked plugins.
1085
+
1086
+ ```
1087
+ USAGE
1088
+ $ springmicro plugins reset [--hard] [--reinstall]
1089
+
1090
+ FLAGS
1091
+ --hard Delete node_modules and package manager related files in addition to uninstalling plugins.
1092
+ --reinstall Reinstall all plugins after uninstalling.
1093
+ ```
1094
+
1095
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/reset.ts)_
1096
+
1097
+ ## `springmicro plugins uninstall [PLUGIN]`
1098
+
1099
+ Removes a plugin from the CLI.
1100
+
1101
+ ```
1102
+ USAGE
1103
+ $ springmicro plugins uninstall [PLUGIN...] [-h] [-v]
1104
+
1105
+ ARGUMENTS
1106
+ PLUGIN... plugin to uninstall
1107
+
1108
+ FLAGS
1109
+ -h, --help Show CLI help.
1110
+ -v, --verbose
1111
+
1112
+ DESCRIPTION
1113
+ Removes a plugin from the CLI.
1114
+
1115
+ ALIASES
1116
+ $ springmicro plugins unlink
1117
+ $ springmicro plugins remove
1118
+
1119
+ EXAMPLES
1120
+ $ springmicro plugins uninstall myplugin
1121
+ ```
1122
+
1123
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/uninstall.ts)_
1124
+
1125
+ ## `springmicro plugins unlink [PLUGIN]`
1126
+
1127
+ Removes a plugin from the CLI.
1128
+
1129
+ ```
1130
+ USAGE
1131
+ $ springmicro plugins unlink [PLUGIN...] [-h] [-v]
1132
+
1133
+ ARGUMENTS
1134
+ PLUGIN... plugin to uninstall
1135
+
1136
+ FLAGS
1137
+ -h, --help Show CLI help.
1138
+ -v, --verbose
1139
+
1140
+ DESCRIPTION
1141
+ Removes a plugin from the CLI.
1142
+
1143
+ ALIASES
1144
+ $ springmicro plugins unlink
1145
+ $ springmicro plugins remove
1146
+
1147
+ EXAMPLES
1148
+ $ springmicro plugins unlink myplugin
1149
+ ```
1150
+
1151
+ ## `springmicro plugins update`
1152
+
1153
+ Update installed plugins.
1154
+
1155
+ ```
1156
+ USAGE
1157
+ $ springmicro plugins update [-h] [-v]
1158
+
1159
+ FLAGS
1160
+ -h, --help Show CLI help.
1161
+ -v, --verbose
1162
+
1163
+ DESCRIPTION
1164
+ Update installed plugins.
1165
+ ```
1166
+
1167
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.2.3/src/commands/plugins/update.ts)_
1168
+
1169
+ <!-- commandsstop -->