@herodevs/cli 1.0.0-beta.1 → 1.0.0-beta.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.
Files changed (2) hide show
  1. package/README.md +326 -5
  2. package/package.json +6 -3
package/README.md CHANGED
@@ -16,7 +16,7 @@ $ npm install -g @herodevs/cli
16
16
  $ hd COMMAND
17
17
  running command...
18
18
  $ hd (--version)
19
- @herodevs/cli/1.0.0-beta.1 linux-x64 node-v22.14.0
19
+ @herodevs/cli/1.0.0-beta.2 linux-x64 node-v22.14.0
20
20
  $ hd --help [COMMAND]
21
21
  USAGE
22
22
  $ hd COMMAND
@@ -25,11 +25,332 @@ USAGE
25
25
  <!-- usagestop -->
26
26
  ## Commands
27
27
  <!-- commands -->
28
+ * [`hd help [COMMAND]`](#hd-help-command)
29
+ * [`hd plugins`](#hd-plugins)
30
+ * [`hd plugins add PLUGIN`](#hd-plugins-add-plugin)
31
+ * [`hd plugins:inspect PLUGIN...`](#hd-pluginsinspect-plugin)
32
+ * [`hd plugins install PLUGIN`](#hd-plugins-install-plugin)
33
+ * [`hd plugins link PATH`](#hd-plugins-link-path)
34
+ * [`hd plugins remove [PLUGIN]`](#hd-plugins-remove-plugin)
35
+ * [`hd plugins reset`](#hd-plugins-reset)
36
+ * [`hd plugins uninstall [PLUGIN]`](#hd-plugins-uninstall-plugin)
37
+ * [`hd plugins unlink [PLUGIN]`](#hd-plugins-unlink-plugin)
38
+ * [`hd plugins update`](#hd-plugins-update)
28
39
  * [`hd report committers`](#hd-report-committers)
29
40
  * [`hd report purls`](#hd-report-purls)
30
41
  * [`hd scan eol`](#hd-scan-eol)
31
42
  * [`hd scan sbom`](#hd-scan-sbom)
32
43
 
44
+ ## `hd help [COMMAND]`
45
+
46
+ Display help for hd.
47
+
48
+ ```
49
+ USAGE
50
+ $ hd help [COMMAND...] [-n]
51
+
52
+ ARGUMENTS
53
+ COMMAND... Command to show help for.
54
+
55
+ FLAGS
56
+ -n, --nested-commands Include all nested commands in the output.
57
+
58
+ DESCRIPTION
59
+ Display help for hd.
60
+ ```
61
+
62
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.27/src/commands/help.ts)_
63
+
64
+ ## `hd plugins`
65
+
66
+ List installed plugins.
67
+
68
+ ```
69
+ USAGE
70
+ $ hd plugins [--json] [--core]
71
+
72
+ FLAGS
73
+ --core Show core plugins.
74
+
75
+ GLOBAL FLAGS
76
+ --json Format output as json.
77
+
78
+ DESCRIPTION
79
+ List installed plugins.
80
+
81
+ EXAMPLES
82
+ $ hd plugins
83
+ ```
84
+
85
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/index.ts)_
86
+
87
+ ## `hd plugins add PLUGIN`
88
+
89
+ Installs a plugin into hd.
90
+
91
+ ```
92
+ USAGE
93
+ $ hd plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
94
+
95
+ ARGUMENTS
96
+ PLUGIN... Plugin to install.
97
+
98
+ FLAGS
99
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
100
+ -h, --help Show CLI help.
101
+ -s, --silent Silences npm output.
102
+ -v, --verbose Show verbose npm output.
103
+
104
+ GLOBAL FLAGS
105
+ --json Format output as json.
106
+
107
+ DESCRIPTION
108
+ Installs a plugin into hd.
109
+
110
+ Uses npm to install plugins.
111
+
112
+ Installation of a user-installed plugin will override a core plugin.
113
+
114
+ Use the HD_NPM_LOG_LEVEL environment variable to set the npm loglevel.
115
+ Use the HD_NPM_REGISTRY environment variable to set the npm registry.
116
+
117
+ ALIASES
118
+ $ hd plugins add
119
+
120
+ EXAMPLES
121
+ Install a plugin from npm registry.
122
+
123
+ $ hd plugins add myplugin
124
+
125
+ Install a plugin from a github url.
126
+
127
+ $ hd plugins add https://github.com/someuser/someplugin
128
+
129
+ Install a plugin from a github slug.
130
+
131
+ $ hd plugins add someuser/someplugin
132
+ ```
133
+
134
+ ## `hd plugins:inspect PLUGIN...`
135
+
136
+ Displays installation properties of a plugin.
137
+
138
+ ```
139
+ USAGE
140
+ $ hd plugins inspect PLUGIN...
141
+
142
+ ARGUMENTS
143
+ PLUGIN... [default: .] Plugin to inspect.
144
+
145
+ FLAGS
146
+ -h, --help Show CLI help.
147
+ -v, --verbose
148
+
149
+ GLOBAL FLAGS
150
+ --json Format output as json.
151
+
152
+ DESCRIPTION
153
+ Displays installation properties of a plugin.
154
+
155
+ EXAMPLES
156
+ $ hd plugins inspect myplugin
157
+ ```
158
+
159
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/inspect.ts)_
160
+
161
+ ## `hd plugins install PLUGIN`
162
+
163
+ Installs a plugin into hd.
164
+
165
+ ```
166
+ USAGE
167
+ $ hd plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
168
+
169
+ ARGUMENTS
170
+ PLUGIN... Plugin to install.
171
+
172
+ FLAGS
173
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
174
+ -h, --help Show CLI help.
175
+ -s, --silent Silences npm output.
176
+ -v, --verbose Show verbose npm output.
177
+
178
+ GLOBAL FLAGS
179
+ --json Format output as json.
180
+
181
+ DESCRIPTION
182
+ Installs a plugin into hd.
183
+
184
+ Uses npm to install plugins.
185
+
186
+ Installation of a user-installed plugin will override a core plugin.
187
+
188
+ Use the HD_NPM_LOG_LEVEL environment variable to set the npm loglevel.
189
+ Use the HD_NPM_REGISTRY environment variable to set the npm registry.
190
+
191
+ ALIASES
192
+ $ hd plugins add
193
+
194
+ EXAMPLES
195
+ Install a plugin from npm registry.
196
+
197
+ $ hd plugins install myplugin
198
+
199
+ Install a plugin from a github url.
200
+
201
+ $ hd plugins install https://github.com/someuser/someplugin
202
+
203
+ Install a plugin from a github slug.
204
+
205
+ $ hd plugins install someuser/someplugin
206
+ ```
207
+
208
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/install.ts)_
209
+
210
+ ## `hd plugins link PATH`
211
+
212
+ Links a plugin into the CLI for development.
213
+
214
+ ```
215
+ USAGE
216
+ $ hd plugins link PATH [-h] [--install] [-v]
217
+
218
+ ARGUMENTS
219
+ PATH [default: .] path to plugin
220
+
221
+ FLAGS
222
+ -h, --help Show CLI help.
223
+ -v, --verbose
224
+ --[no-]install Install dependencies after linking the plugin.
225
+
226
+ DESCRIPTION
227
+ Links a plugin into the CLI for development.
228
+
229
+ Installation of a linked plugin will override a user-installed or core plugin.
230
+
231
+ e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
232
+ command will override the user-installed or core plugin implementation. This is useful for development work.
233
+
234
+
235
+ EXAMPLES
236
+ $ hd plugins link myplugin
237
+ ```
238
+
239
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/link.ts)_
240
+
241
+ ## `hd plugins remove [PLUGIN]`
242
+
243
+ Removes a plugin from the CLI.
244
+
245
+ ```
246
+ USAGE
247
+ $ hd plugins remove [PLUGIN...] [-h] [-v]
248
+
249
+ ARGUMENTS
250
+ PLUGIN... plugin to uninstall
251
+
252
+ FLAGS
253
+ -h, --help Show CLI help.
254
+ -v, --verbose
255
+
256
+ DESCRIPTION
257
+ Removes a plugin from the CLI.
258
+
259
+ ALIASES
260
+ $ hd plugins unlink
261
+ $ hd plugins remove
262
+
263
+ EXAMPLES
264
+ $ hd plugins remove myplugin
265
+ ```
266
+
267
+ ## `hd plugins reset`
268
+
269
+ Remove all user-installed and linked plugins.
270
+
271
+ ```
272
+ USAGE
273
+ $ hd plugins reset [--hard] [--reinstall]
274
+
275
+ FLAGS
276
+ --hard Delete node_modules and package manager related files in addition to uninstalling plugins.
277
+ --reinstall Reinstall all plugins after uninstalling.
278
+ ```
279
+
280
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/reset.ts)_
281
+
282
+ ## `hd plugins uninstall [PLUGIN]`
283
+
284
+ Removes a plugin from the CLI.
285
+
286
+ ```
287
+ USAGE
288
+ $ hd plugins uninstall [PLUGIN...] [-h] [-v]
289
+
290
+ ARGUMENTS
291
+ PLUGIN... plugin to uninstall
292
+
293
+ FLAGS
294
+ -h, --help Show CLI help.
295
+ -v, --verbose
296
+
297
+ DESCRIPTION
298
+ Removes a plugin from the CLI.
299
+
300
+ ALIASES
301
+ $ hd plugins unlink
302
+ $ hd plugins remove
303
+
304
+ EXAMPLES
305
+ $ hd plugins uninstall myplugin
306
+ ```
307
+
308
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/uninstall.ts)_
309
+
310
+ ## `hd plugins unlink [PLUGIN]`
311
+
312
+ Removes a plugin from the CLI.
313
+
314
+ ```
315
+ USAGE
316
+ $ hd plugins unlink [PLUGIN...] [-h] [-v]
317
+
318
+ ARGUMENTS
319
+ PLUGIN... plugin to uninstall
320
+
321
+ FLAGS
322
+ -h, --help Show CLI help.
323
+ -v, --verbose
324
+
325
+ DESCRIPTION
326
+ Removes a plugin from the CLI.
327
+
328
+ ALIASES
329
+ $ hd plugins unlink
330
+ $ hd plugins remove
331
+
332
+ EXAMPLES
333
+ $ hd plugins unlink myplugin
334
+ ```
335
+
336
+ ## `hd plugins update`
337
+
338
+ Update installed plugins.
339
+
340
+ ```
341
+ USAGE
342
+ $ hd plugins update [-h] [-v]
343
+
344
+ FLAGS
345
+ -h, --help Show CLI help.
346
+ -v, --verbose
347
+
348
+ DESCRIPTION
349
+ Update installed plugins.
350
+ ```
351
+
352
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/update.ts)_
353
+
33
354
  ## `hd report committers`
34
355
 
35
356
  Generate report of committers to a git repository
@@ -60,7 +381,7 @@ EXAMPLES
60
381
  $ hd report committers --output=csv
61
382
  ```
62
383
 
63
- _See code: [src/commands/report/committers.ts](https://github.com/herodevs/cli/blob/v1.0.0-beta.1/src/commands/report/committers.ts)_
384
+ _See code: [src/commands/report/committers.ts](https://github.com/herodevs/cli/blob/v1.0.0-beta.2/src/commands/report/committers.ts)_
64
385
 
65
386
  ## `hd report purls`
66
387
 
@@ -93,7 +414,7 @@ EXAMPLES
93
414
  $ hd report purls --save --output=csv
94
415
  ```
95
416
 
96
- _See code: [src/commands/report/purls.ts](https://github.com/herodevs/cli/blob/v1.0.0-beta.1/src/commands/report/purls.ts)_
417
+ _See code: [src/commands/report/purls.ts](https://github.com/herodevs/cli/blob/v1.0.0-beta.2/src/commands/report/purls.ts)_
97
418
 
98
419
  ## `hd scan eol`
99
420
 
@@ -120,7 +441,7 @@ EXAMPLES
120
441
  $ hd scan eol --file=path/to/sbom.json
121
442
  ```
122
443
 
123
- _See code: [src/commands/scan/eol.ts](https://github.com/herodevs/cli/blob/v1.0.0-beta.1/src/commands/scan/eol.ts)_
444
+ _See code: [src/commands/scan/eol.ts](https://github.com/herodevs/cli/blob/v1.0.0-beta.2/src/commands/scan/eol.ts)_
124
445
 
125
446
  ## `hd scan sbom`
126
447
 
@@ -147,5 +468,5 @@ EXAMPLES
147
468
  $ hd scan sbom --file=path/to/sbom.json
148
469
  ```
149
470
 
150
- _See code: [src/commands/scan/sbom.ts](https://github.com/herodevs/cli/blob/v1.0.0-beta.1/src/commands/scan/sbom.ts)_
471
+ _See code: [src/commands/scan/sbom.ts](https://github.com/herodevs/cli/blob/v1.0.0-beta.2/src/commands/scan/sbom.ts)_
151
472
  <!-- commandsstop -->
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@herodevs/cli",
3
- "version": "1.0.0-beta.1",
3
+ "version": "1.0.0-beta.2",
4
4
  "author": "HeroDevs, Inc",
5
5
  "bin": {
6
6
  "hd": "./bin/run.js"
@@ -36,9 +36,12 @@
36
36
  ],
37
37
  "dependencies": {
38
38
  "@apollo/client": "^3.13.1",
39
+ "@cyclonedx/cdxgen": "^11.2.2",
40
+ "@oclif/core": "^4",
41
+ "@oclif/plugin-help": "^6",
42
+ "@oclif/plugin-plugins": "^5",
39
43
  "graphql": "^16.8.1",
40
- "inquirer": "^12.5.0",
41
- "@oclif/core": "^4"
44
+ "inquirer": "^12.5.0"
42
45
  },
43
46
  "devDependencies": {
44
47
  "@biomejs/biome": "^1.8.3",