@pump-inc/cli 0.0.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.
Files changed (39) hide show
  1. package/README.md +905 -0
  2. package/bin/dev.cmd +3 -0
  3. package/bin/dev.js +7 -0
  4. package/bin/run-pkg.js +13 -0
  5. package/bin/run.cmd +3 -0
  6. package/bin/run.js +7 -0
  7. package/dist/api-XWM8zKbb.cjs +21 -0
  8. package/dist/api-client-bnV0ib_r.cjs +1207 -0
  9. package/dist/base-command-GfDxcqx6.cjs +451 -0
  10. package/dist/bin.cjs +15 -0
  11. package/dist/chunk-CbDLau6x.cjs +34 -0
  12. package/dist/commands/admin/config/set.cjs +40 -0
  13. package/dist/commands/admin/organization/create.cjs +83 -0
  14. package/dist/commands/admin/organization/get.cjs +77 -0
  15. package/dist/commands/admin/organization/list.cjs +103 -0
  16. package/dist/commands/admin/user/create.cjs +82 -0
  17. package/dist/commands/api-key/create.cjs +81 -0
  18. package/dist/commands/api-key/delete.cjs +48 -0
  19. package/dist/commands/api-key/list.cjs +85 -0
  20. package/dist/commands/api-key/update.cjs +81 -0
  21. package/dist/commands/app/create.cjs +97 -0
  22. package/dist/commands/app/deploy.cjs +74 -0
  23. package/dist/commands/app/list.cjs +64 -0
  24. package/dist/commands/app/secrets.cjs +43 -0
  25. package/dist/commands/app/status.cjs +78 -0
  26. package/dist/commands/app/stop.cjs +49 -0
  27. package/dist/commands/app/usage.cjs +79 -0
  28. package/dist/commands/auth/test.cjs +56 -0
  29. package/dist/commands/config/validate.cjs +32 -0
  30. package/dist/commands/project/create.cjs +79 -0
  31. package/dist/fix-event-emitter-uhRntilb.cjs +21 -0
  32. package/dist/index.cjs +16 -0
  33. package/dist/util/api.cjs +3 -0
  34. package/dist/util/base-command.cjs +4 -0
  35. package/dist/util/fix-event-emitter.cjs +3 -0
  36. package/dist/util/validate-config.cjs +3 -0
  37. package/dist/validate-config-C9krCzRv.cjs +24 -0
  38. package/oclif.manifest.json +1099 -0
  39. package/package.json +85 -0
package/README.md ADDED
@@ -0,0 +1,905 @@
1
+ # pump-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/pump-cli.svg)](https://npmjs.org/package/pump-cli)
7
+ [![Downloads/week](https://img.shields.io/npm/dw/pump-cli.svg)](https://npmjs.org/package/pump-cli)
8
+
9
+ <!-- toc -->
10
+ * [pump-cli](#pump-cli)
11
+ * [Usage](#usage)
12
+ * [Commands](#commands)
13
+ <!-- tocstop -->
14
+
15
+ # Usage
16
+
17
+ <!-- usage -->
18
+ ```sh-session
19
+ $ npm install -g @pump-inc/cli
20
+ $ pump-cli COMMAND
21
+ running command...
22
+ $ pump-cli (--version)
23
+ @pump-inc/cli/0.0.1 darwin-arm64 node-v24.10.0
24
+ $ pump-cli --help [COMMAND]
25
+ USAGE
26
+ $ pump-cli COMMAND
27
+ ...
28
+ ```
29
+ <!-- usagestop -->
30
+
31
+ # Commands
32
+
33
+ <!-- commands -->
34
+ * [`pump-cli admin config set [VALUE]`](#pump-cli-admin-config-set-value)
35
+ * [`pump-cli admin organization create NAME USERID`](#pump-cli-admin-organization-create-name-userid)
36
+ * [`pump-cli admin organization get ORGANIZATIONID`](#pump-cli-admin-organization-get-organizationid)
37
+ * [`pump-cli admin organization list`](#pump-cli-admin-organization-list)
38
+ * [`pump-cli admin user create NAME EMAIL`](#pump-cli-admin-user-create-name-email)
39
+ * [`pump-cli api-key create NAME`](#pump-cli-api-key-create-name)
40
+ * [`pump-cli api-key delete ID`](#pump-cli-api-key-delete-id)
41
+ * [`pump-cli api-key list`](#pump-cli-api-key-list)
42
+ * [`pump-cli api-key update ID`](#pump-cli-api-key-update-id)
43
+ * [`pump-cli app create NAME`](#pump-cli-app-create-name)
44
+ * [`pump-cli app deploy [FILE]`](#pump-cli-app-deploy-file)
45
+ * [`pump-cli app list [FILE]`](#pump-cli-app-list-file)
46
+ * [`pump-cli app secrets APPLICATIONID`](#pump-cli-app-secrets-applicationid)
47
+ * [`pump-cli app status [APPLICATIONID]`](#pump-cli-app-status-applicationid)
48
+ * [`pump-cli app stop`](#pump-cli-app-stop)
49
+ * [`pump-cli app usage [APPLICATIONID]`](#pump-cli-app-usage-applicationid)
50
+ * [`pump-cli auth test`](#pump-cli-auth-test)
51
+ * [`pump-cli config validate [FILE]`](#pump-cli-config-validate-file)
52
+ * [`pump-cli help [COMMAND]`](#pump-cli-help-command)
53
+ * [`pump-cli plugins`](#pump-cli-plugins)
54
+ * [`pump-cli plugins add PLUGIN`](#pump-cli-plugins-add-plugin)
55
+ * [`pump-cli plugins:inspect PLUGIN...`](#pump-cli-pluginsinspect-plugin)
56
+ * [`pump-cli plugins install PLUGIN`](#pump-cli-plugins-install-plugin)
57
+ * [`pump-cli plugins link PATH`](#pump-cli-plugins-link-path)
58
+ * [`pump-cli plugins remove [PLUGIN]`](#pump-cli-plugins-remove-plugin)
59
+ * [`pump-cli plugins reset`](#pump-cli-plugins-reset)
60
+ * [`pump-cli plugins uninstall [PLUGIN]`](#pump-cli-plugins-uninstall-plugin)
61
+ * [`pump-cli plugins unlink [PLUGIN]`](#pump-cli-plugins-unlink-plugin)
62
+ * [`pump-cli plugins update`](#pump-cli-plugins-update)
63
+ * [`pump-cli project create NAME`](#pump-cli-project-create-name)
64
+
65
+ ## `pump-cli admin config set [VALUE]`
66
+
67
+ This command is used to set global configuration keys in the DB (admin only)
68
+
69
+ ```
70
+ USAGE
71
+ $ pump-cli admin config set [VALUE] [-c <value>] [-k <value>]
72
+
73
+ ARGUMENTS
74
+ [VALUE] value to set
75
+
76
+ FLAGS
77
+ -c, --key=<value> key to set
78
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
79
+
80
+ DESCRIPTION
81
+ This command is used to set global configuration keys in the DB (admin only)
82
+
83
+ EXAMPLES
84
+ $ pump-cli admin config set
85
+ ```
86
+
87
+ _See code: [src/commands/admin/config/set.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/admin/config/set.ts)_
88
+
89
+ ## `pump-cli admin organization create NAME USERID`
90
+
91
+ Create a new organization (admin only)
92
+
93
+ ```
94
+ USAGE
95
+ $ pump-cli admin organization create NAME USERID [-j] [-d <value>] [-D <value>] [-s] [-k <value>]
96
+
97
+ ARGUMENTS
98
+ NAME Organization name
99
+ USERID User ID to be set as organization owner
100
+
101
+ FLAGS
102
+ -D, --domain=<value> Organization domain name
103
+ -d, --description=<value> Organization description
104
+ -j, --json Output as JSON
105
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
106
+ -s, --skipReconcilerJob Skip creating reconciler job for this organization
107
+
108
+ DESCRIPTION
109
+ Create a new organization (admin only)
110
+
111
+ EXAMPLES
112
+ $ pump-cli admin organization create "Acme Corp" user_1234567890
113
+
114
+ $ pump-cli admin organization create "Tech Startup" user_1234567890 --description="A cutting-edge technology company"
115
+
116
+ $ pump-cli admin organization create "Enterprise Ltd" user_1234567890 --description="Enterprise solutions" --domain="enterprise.com"
117
+
118
+ $ pump-cli admin organization create "Quick Org" user_1234567890 --skipReconcilerJob
119
+
120
+ $ pump-cli admin organization create "Json Org" user_1234567890 --json
121
+ ```
122
+
123
+ _See code: [src/commands/admin/organization/create.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/admin/organization/create.ts)_
124
+
125
+ ## `pump-cli admin organization get ORGANIZATIONID`
126
+
127
+ Get organization details with owner and members (admin only)
128
+
129
+ ```
130
+ USAGE
131
+ $ pump-cli admin organization get ORGANIZATIONID [-j] [-m] [-k <value>]
132
+
133
+ ARGUMENTS
134
+ ORGANIZATIONID Organization ID to retrieve
135
+
136
+ FLAGS
137
+ -j, --json Output as JSON
138
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
139
+ -m, --membersOnly Show only members information
140
+
141
+ DESCRIPTION
142
+ Get organization details with owner and members (admin only)
143
+
144
+ EXAMPLES
145
+ $ pump-cli admin organization get org_1234567890
146
+
147
+ $ pump-cli admin organization get org_1234567890 --json
148
+
149
+ $ pump-cli admin organization get org_1234567890 --members-only
150
+ ```
151
+
152
+ _See code: [src/commands/admin/organization/get.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/admin/organization/get.ts)_
153
+
154
+ ## `pump-cli admin organization list`
155
+
156
+ List all organizations (admin only)
157
+
158
+ ```
159
+ USAGE
160
+ $ pump-cli admin organization list [-j] [-s name|created|members] [-d] [-k <value>]
161
+
162
+ FLAGS
163
+ -d, --desc Sort in descending order
164
+ -j, --json Output as JSON
165
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
166
+ -s, --sortBy=<option> [default: name] Sort by field
167
+ <options: name|created|members>
168
+
169
+ DESCRIPTION
170
+ List all organizations (admin only)
171
+
172
+ EXAMPLES
173
+ $ pump-cli admin organization list
174
+
175
+ $ pump-cli admin organization list --json
176
+
177
+ $ pump-cli admin organization list --sort-by=name
178
+
179
+ $ pump-cli admin organization list --sort-by=created --desc
180
+ ```
181
+
182
+ _See code: [src/commands/admin/organization/list.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/admin/organization/list.ts)_
183
+
184
+ ## `pump-cli admin user create NAME EMAIL`
185
+
186
+ Create a new user (admin only)
187
+
188
+ ```
189
+ USAGE
190
+ $ pump-cli admin user create NAME EMAIL [-j] [-a] [-v] [-i <value>] [-k <value>]
191
+
192
+ ARGUMENTS
193
+ NAME User's full name
194
+ EMAIL User's email address
195
+
196
+ FLAGS
197
+ -a, --admin Make the user an admin
198
+ -i, --image=<value> User's profile image URL
199
+ -j, --json Output as JSON
200
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
201
+ -v, --verified Mark the user's email as verified
202
+
203
+ DESCRIPTION
204
+ Create a new user (admin only)
205
+
206
+ EXAMPLES
207
+ $ pump-cli admin user create "John Doe" john@example.com
208
+
209
+ $ pump-cli admin user create "Jane Admin" jane@example.com --admin
210
+
211
+ $ pump-cli admin user create "Bob User" bob@example.com --admin --verified --image="https://example.com/avatar.jpg"
212
+
213
+ $ pump-cli admin user create "Json User" json@example.com --json
214
+ ```
215
+
216
+ _See code: [src/commands/admin/user/create.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/admin/user/create.ts)_
217
+
218
+ ## `pump-cli api-key create NAME`
219
+
220
+ Create a new API key for your organization
221
+
222
+ ```
223
+ USAGE
224
+ $ pump-cli api-key create NAME [-d <value>] [-s active|inactive|revoked|pending|suspended] [-k <value>]
225
+
226
+ ARGUMENTS
227
+ NAME API key name
228
+
229
+ FLAGS
230
+ -d, --description=<value> API key description
231
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
232
+ -s, --status=<option> [default: active] API key status
233
+ <options: active|inactive|revoked|pending|suspended>
234
+
235
+ DESCRIPTION
236
+ Create a new API key for your organization
237
+
238
+ EXAMPLES
239
+ $ pump-cli api-key create "My API Key"
240
+
241
+ $ pump-cli api-key create "Production API" --description="For production use" --status=active
242
+
243
+ $ pump-cli api-key create "Test Key" --description="Temporary test key" --status=pending
244
+ ```
245
+
246
+ _See code: [src/commands/api-key/create.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/api-key/create.ts)_
247
+
248
+ ## `pump-cli api-key delete ID`
249
+
250
+ Delete an API key
251
+
252
+ ```
253
+ USAGE
254
+ $ pump-cli api-key delete ID [-f] [-k <value>]
255
+
256
+ ARGUMENTS
257
+ ID API key ID to delete
258
+
259
+ FLAGS
260
+ -f, --force Skip confirmation prompt
261
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
262
+
263
+ DESCRIPTION
264
+ Delete an API key
265
+
266
+ EXAMPLES
267
+ $ pump-cli api-key delete abc-123
268
+
269
+ $ pump-cli api-key delete abc-123 --force
270
+ ```
271
+
272
+ _See code: [src/commands/api-key/delete.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/api-key/delete.ts)_
273
+
274
+ ## `pump-cli api-key list`
275
+
276
+ List all API keys for your organization
277
+
278
+ ```
279
+ USAGE
280
+ $ pump-cli api-key list [-j] [-s active|inactive|revoked|pending|suspended] [-k <value>]
281
+
282
+ FLAGS
283
+ -j, --json Output as JSON
284
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
285
+ -s, --status=<option> Filter by status
286
+ <options: active|inactive|revoked|pending|suspended>
287
+
288
+ DESCRIPTION
289
+ List all API keys for your organization
290
+
291
+ EXAMPLES
292
+ $ pump-cli api-key list
293
+
294
+ $ pump-cli api-key list --json
295
+
296
+ $ pump-cli api-key list --status=active
297
+ ```
298
+
299
+ _See code: [src/commands/api-key/list.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/api-key/list.ts)_
300
+
301
+ ## `pump-cli api-key update ID`
302
+
303
+ Update an existing API key
304
+
305
+ ```
306
+ USAGE
307
+ $ pump-cli api-key update ID [-n <value>] [-d <value>] [-s active|inactive|revoked|pending|suspended] [-k <value>]
308
+
309
+ ARGUMENTS
310
+ ID API key ID to update
311
+
312
+ FLAGS
313
+ -d, --description=<value> New API key description
314
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
315
+ -n, --name=<value> New API key name
316
+ -s, --status=<option> New API key status
317
+ <options: active|inactive|revoked|pending|suspended>
318
+
319
+ DESCRIPTION
320
+ Update an existing API key
321
+
322
+ EXAMPLES
323
+ $ pump-cli api-key update abc-123 --name="Updated Name"
324
+
325
+ $ pump-cli api-key update abc-123 --description="New description" --status=inactive
326
+
327
+ $ pump-cli api-key update abc-123 --status=revoked
328
+ ```
329
+
330
+ _See code: [src/commands/api-key/update.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/api-key/update.ts)_
331
+
332
+ ## `pump-cli app create NAME`
333
+
334
+ Create a new application
335
+
336
+ ```
337
+ USAGE
338
+ $ pump-cli app create NAME -p <value> [-t processor|cron] [-s pending|active|inactive] [--cpu <value>]
339
+ [--memory <value>] [--storage <value>] [--network <value>] [-k <value>] [--json]
340
+
341
+ ARGUMENTS
342
+ NAME Application name
343
+
344
+ FLAGS
345
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
346
+ -p, --project-id=<value> (required) Project ID where the application will be created
347
+ -s, --status=<option> [default: pending] Application status
348
+ <options: pending|active|inactive>
349
+ -t, --type=<option> [default: processor] Application type
350
+ <options: processor|cron>
351
+ --cpu=<value> CPU resources (cores)
352
+ --json Output result as JSON
353
+ --memory=<value> Memory resources (MB)
354
+ --network=<value> Network resources (Mbps)
355
+ --storage=<value> Storage resources (GB)
356
+
357
+ DESCRIPTION
358
+ Create a new application
359
+
360
+ EXAMPLES
361
+ $ pump-cli app create "My App" --project-id=proj-123 --type=processor
362
+
363
+ $ pump-cli app create "API Service" --project-id=proj-456 --type=processor --cpu=1 --memory=512
364
+
365
+ $ pump-cli app create "Worker" --project-id=proj-789 --type=cron --cpu=2 --status=active
366
+
367
+ $ pump-cli app create "My App" --project-id=proj-123 --type=processor --json
368
+ ```
369
+
370
+ _See code: [src/commands/app/create.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/app/create.ts)_
371
+
372
+ ## `pump-cli app deploy [FILE]`
373
+
374
+ Deploy an application by providing a config file
375
+
376
+ ```
377
+ USAGE
378
+ $ pump-cli app deploy [FILE] -a <value> [-f] [-n <value>] [-k <value>] [--json]
379
+
380
+ ARGUMENTS
381
+ [FILE] file to read
382
+
383
+ FLAGS
384
+ -a, --appId=<value> (required) [env: PUMPINC_APP_ID] application id to deploy
385
+ -f, --force
386
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
387
+ -n, --name=<value> Deployment name
388
+ --json Output result as JSON
389
+
390
+ DESCRIPTION
391
+ Deploy an application by providing a config file
392
+
393
+ EXAMPLES
394
+ $ pump-cli app deploy config-file.yaml
395
+ ```
396
+
397
+ _See code: [src/commands/app/deploy.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/app/deploy.ts)_
398
+
399
+ ## `pump-cli app list [FILE]`
400
+
401
+ describe the command here
402
+
403
+ ```
404
+ USAGE
405
+ $ pump-cli app list [FILE] [-v] [-k <value>]
406
+
407
+ ARGUMENTS
408
+ [FILE] file to read
409
+
410
+ FLAGS
411
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
412
+ -v, --verbose Show detailed application info
413
+
414
+ DESCRIPTION
415
+ describe the command here
416
+
417
+ EXAMPLES
418
+ $ pump-cli app list
419
+ ```
420
+
421
+ _See code: [src/commands/app/list.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/app/list.ts)_
422
+
423
+ ## `pump-cli app secrets APPLICATIONID`
424
+
425
+ List all secrets for an application
426
+
427
+ ```
428
+ USAGE
429
+ $ pump-cli app secrets APPLICATIONID [-k <value>]
430
+
431
+ ARGUMENTS
432
+ APPLICATIONID Application ID to list secrets for
433
+
434
+ FLAGS
435
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
436
+
437
+ DESCRIPTION
438
+ List all secrets for an application
439
+
440
+ EXAMPLES
441
+ $ pump-cli app secrets app_12345
442
+
443
+ $ pump-cli app secrets app_12345 -k your-api-key
444
+ ```
445
+
446
+ _See code: [src/commands/app/secrets.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/app/secrets.ts)_
447
+
448
+ ## `pump-cli app status [APPLICATIONID]`
449
+
450
+ Get the status of a specific application by its ID
451
+
452
+ ```
453
+ USAGE
454
+ $ pump-cli app status [APPLICATIONID] [-k <value>]
455
+
456
+ ARGUMENTS
457
+ [APPLICATIONID] Application ID to get status for eg. app_1234567890abcdef
458
+
459
+ FLAGS
460
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
461
+
462
+ DESCRIPTION
463
+ Get the status of a specific application by its ID
464
+
465
+ EXAMPLES
466
+ $ pump-cli app status
467
+ ```
468
+
469
+ _See code: [src/commands/app/status.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/app/status.ts)_
470
+
471
+ ## `pump-cli app stop`
472
+
473
+ Stop the running deployment for an application
474
+
475
+ ```
476
+ USAGE
477
+ $ pump-cli app stop -a <value> [-k <value>] [--json]
478
+
479
+ FLAGS
480
+ -a, --appId=<value> (required) [env: PUMPINC_APP_ID] application id to stop deployment for
481
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
482
+ --json Output result as JSON
483
+
484
+ DESCRIPTION
485
+ Stop the running deployment for an application
486
+
487
+ EXAMPLES
488
+ $ pump-cli app stop --appId <application-id>
489
+ ```
490
+
491
+ _See code: [src/commands/app/stop.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/app/stop.ts)_
492
+
493
+ ## `pump-cli app usage [APPLICATIONID]`
494
+
495
+ get usage information for an application including execution units and CPU/memory usage
496
+
497
+ ```
498
+ USAGE
499
+ $ pump-cli app usage [APPLICATIONID] [-h] [-k <value>]
500
+
501
+ ARGUMENTS
502
+ [APPLICATIONID] application ID to get usage for
503
+
504
+ FLAGS
505
+ -h, --hide hide deployment details
506
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
507
+
508
+ DESCRIPTION
509
+ get usage information for an application including execution units and CPU/memory usage
510
+
511
+ EXAMPLES
512
+ $ pump-cli app usage app_aaaabbbbccccddddeeee
513
+ ```
514
+
515
+ _See code: [src/commands/app/usage.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/app/usage.ts)_
516
+
517
+ ## `pump-cli auth test`
518
+
519
+ Test API authentication with the configured API key
520
+
521
+ ```
522
+ USAGE
523
+ $ pump-cli auth test [-v] [-k <value>]
524
+
525
+ FLAGS
526
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
527
+ -v, --verbose Show detailed authentication information
528
+
529
+ DESCRIPTION
530
+ Test API authentication with the configured API key
531
+
532
+ EXAMPLES
533
+ $ pump-cli auth test
534
+
535
+ $ pump-cli auth test --verbose
536
+ ```
537
+
538
+ _See code: [src/commands/auth/test.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/auth/test.ts)_
539
+
540
+ ## `pump-cli config validate [FILE]`
541
+
542
+ validate a config file
543
+
544
+ ```
545
+ USAGE
546
+ $ pump-cli config validate [FILE] [-k <value>]
547
+
548
+ ARGUMENTS
549
+ [FILE] file to read
550
+
551
+ FLAGS
552
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
553
+
554
+ DESCRIPTION
555
+ validate a config file
556
+
557
+ EXAMPLES
558
+ $ pump-cli config validate <file>
559
+ ```
560
+
561
+ _See code: [src/commands/config/validate.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/config/validate.ts)_
562
+
563
+ ## `pump-cli help [COMMAND]`
564
+
565
+ Display help for pump-cli.
566
+
567
+ ```
568
+ USAGE
569
+ $ pump-cli help [COMMAND...] [-n]
570
+
571
+ ARGUMENTS
572
+ [COMMAND...] Command to show help for.
573
+
574
+ FLAGS
575
+ -n, --nested-commands Include all nested commands in the output.
576
+
577
+ DESCRIPTION
578
+ Display help for pump-cli.
579
+ ```
580
+
581
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.36/src/commands/help.ts)_
582
+
583
+ ## `pump-cli plugins`
584
+
585
+ List installed plugins.
586
+
587
+ ```
588
+ USAGE
589
+ $ pump-cli plugins [--json] [--core]
590
+
591
+ FLAGS
592
+ --core Show core plugins.
593
+
594
+ GLOBAL FLAGS
595
+ --json Format output as json.
596
+
597
+ DESCRIPTION
598
+ List installed plugins.
599
+
600
+ EXAMPLES
601
+ $ pump-cli plugins
602
+ ```
603
+
604
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/index.ts)_
605
+
606
+ ## `pump-cli plugins add PLUGIN`
607
+
608
+ Installs a plugin into pump-cli.
609
+
610
+ ```
611
+ USAGE
612
+ $ pump-cli plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
613
+
614
+ ARGUMENTS
615
+ PLUGIN... Plugin to install.
616
+
617
+ FLAGS
618
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
619
+ -h, --help Show CLI help.
620
+ -s, --silent Silences npm output.
621
+ -v, --verbose Show verbose npm output.
622
+
623
+ GLOBAL FLAGS
624
+ --json Format output as json.
625
+
626
+ DESCRIPTION
627
+ Installs a plugin into pump-cli.
628
+
629
+ Uses npm to install plugins.
630
+
631
+ Installation of a user-installed plugin will override a core plugin.
632
+
633
+ Use the PUMP_CLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
634
+ Use the PUMP_CLI_NPM_REGISTRY environment variable to set the npm registry.
635
+
636
+ ALIASES
637
+ $ pump-cli plugins add
638
+
639
+ EXAMPLES
640
+ Install a plugin from npm registry.
641
+
642
+ $ pump-cli plugins add myplugin
643
+
644
+ Install a plugin from a github url.
645
+
646
+ $ pump-cli plugins add https://github.com/someuser/someplugin
647
+
648
+ Install a plugin from a github slug.
649
+
650
+ $ pump-cli plugins add someuser/someplugin
651
+ ```
652
+
653
+ ## `pump-cli plugins:inspect PLUGIN...`
654
+
655
+ Displays installation properties of a plugin.
656
+
657
+ ```
658
+ USAGE
659
+ $ pump-cli plugins inspect PLUGIN...
660
+
661
+ ARGUMENTS
662
+ PLUGIN... [default: .] Plugin to inspect.
663
+
664
+ FLAGS
665
+ -h, --help Show CLI help.
666
+ -v, --verbose
667
+
668
+ GLOBAL FLAGS
669
+ --json Format output as json.
670
+
671
+ DESCRIPTION
672
+ Displays installation properties of a plugin.
673
+
674
+ EXAMPLES
675
+ $ pump-cli plugins inspect myplugin
676
+ ```
677
+
678
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/inspect.ts)_
679
+
680
+ ## `pump-cli plugins install PLUGIN`
681
+
682
+ Installs a plugin into pump-cli.
683
+
684
+ ```
685
+ USAGE
686
+ $ pump-cli plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
687
+
688
+ ARGUMENTS
689
+ PLUGIN... Plugin to install.
690
+
691
+ FLAGS
692
+ -f, --force Force npm to fetch remote resources even if a local copy exists on disk.
693
+ -h, --help Show CLI help.
694
+ -s, --silent Silences npm output.
695
+ -v, --verbose Show verbose npm output.
696
+
697
+ GLOBAL FLAGS
698
+ --json Format output as json.
699
+
700
+ DESCRIPTION
701
+ Installs a plugin into pump-cli.
702
+
703
+ Uses npm to install plugins.
704
+
705
+ Installation of a user-installed plugin will override a core plugin.
706
+
707
+ Use the PUMP_CLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
708
+ Use the PUMP_CLI_NPM_REGISTRY environment variable to set the npm registry.
709
+
710
+ ALIASES
711
+ $ pump-cli plugins add
712
+
713
+ EXAMPLES
714
+ Install a plugin from npm registry.
715
+
716
+ $ pump-cli plugins install myplugin
717
+
718
+ Install a plugin from a github url.
719
+
720
+ $ pump-cli plugins install https://github.com/someuser/someplugin
721
+
722
+ Install a plugin from a github slug.
723
+
724
+ $ pump-cli plugins install someuser/someplugin
725
+ ```
726
+
727
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/install.ts)_
728
+
729
+ ## `pump-cli plugins link PATH`
730
+
731
+ Links a plugin into the CLI for development.
732
+
733
+ ```
734
+ USAGE
735
+ $ pump-cli plugins link PATH [-h] [--install] [-v]
736
+
737
+ ARGUMENTS
738
+ PATH [default: .] path to plugin
739
+
740
+ FLAGS
741
+ -h, --help Show CLI help.
742
+ -v, --verbose
743
+ --[no-]install Install dependencies after linking the plugin.
744
+
745
+ DESCRIPTION
746
+ Links a plugin into the CLI for development.
747
+
748
+ Installation of a linked plugin will override a user-installed or core plugin.
749
+
750
+ e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
751
+ command will override the user-installed or core plugin implementation. This is useful for development work.
752
+
753
+
754
+ EXAMPLES
755
+ $ pump-cli plugins link myplugin
756
+ ```
757
+
758
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/link.ts)_
759
+
760
+ ## `pump-cli plugins remove [PLUGIN]`
761
+
762
+ Removes a plugin from the CLI.
763
+
764
+ ```
765
+ USAGE
766
+ $ pump-cli plugins remove [PLUGIN...] [-h] [-v]
767
+
768
+ ARGUMENTS
769
+ [PLUGIN...] plugin to uninstall
770
+
771
+ FLAGS
772
+ -h, --help Show CLI help.
773
+ -v, --verbose
774
+
775
+ DESCRIPTION
776
+ Removes a plugin from the CLI.
777
+
778
+ ALIASES
779
+ $ pump-cli plugins unlink
780
+ $ pump-cli plugins remove
781
+
782
+ EXAMPLES
783
+ $ pump-cli plugins remove myplugin
784
+ ```
785
+
786
+ ## `pump-cli plugins reset`
787
+
788
+ Remove all user-installed and linked plugins.
789
+
790
+ ```
791
+ USAGE
792
+ $ pump-cli plugins reset [--hard] [--reinstall]
793
+
794
+ FLAGS
795
+ --hard Delete node_modules and package manager related files in addition to uninstalling plugins.
796
+ --reinstall Reinstall all plugins after uninstalling.
797
+ ```
798
+
799
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/reset.ts)_
800
+
801
+ ## `pump-cli plugins uninstall [PLUGIN]`
802
+
803
+ Removes a plugin from the CLI.
804
+
805
+ ```
806
+ USAGE
807
+ $ pump-cli plugins uninstall [PLUGIN...] [-h] [-v]
808
+
809
+ ARGUMENTS
810
+ [PLUGIN...] plugin to uninstall
811
+
812
+ FLAGS
813
+ -h, --help Show CLI help.
814
+ -v, --verbose
815
+
816
+ DESCRIPTION
817
+ Removes a plugin from the CLI.
818
+
819
+ ALIASES
820
+ $ pump-cli plugins unlink
821
+ $ pump-cli plugins remove
822
+
823
+ EXAMPLES
824
+ $ pump-cli plugins uninstall myplugin
825
+ ```
826
+
827
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/uninstall.ts)_
828
+
829
+ ## `pump-cli plugins unlink [PLUGIN]`
830
+
831
+ Removes a plugin from the CLI.
832
+
833
+ ```
834
+ USAGE
835
+ $ pump-cli plugins unlink [PLUGIN...] [-h] [-v]
836
+
837
+ ARGUMENTS
838
+ [PLUGIN...] plugin to uninstall
839
+
840
+ FLAGS
841
+ -h, --help Show CLI help.
842
+ -v, --verbose
843
+
844
+ DESCRIPTION
845
+ Removes a plugin from the CLI.
846
+
847
+ ALIASES
848
+ $ pump-cli plugins unlink
849
+ $ pump-cli plugins remove
850
+
851
+ EXAMPLES
852
+ $ pump-cli plugins unlink myplugin
853
+ ```
854
+
855
+ ## `pump-cli plugins update`
856
+
857
+ Update installed plugins.
858
+
859
+ ```
860
+ USAGE
861
+ $ pump-cli plugins update [-h] [-v]
862
+
863
+ FLAGS
864
+ -h, --help Show CLI help.
865
+ -v, --verbose
866
+
867
+ DESCRIPTION
868
+ Update installed plugins.
869
+ ```
870
+
871
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/update.ts)_
872
+
873
+ ## `pump-cli project create NAME`
874
+
875
+ Create a new project in your organization
876
+
877
+ ```
878
+ USAGE
879
+ $ pump-cli project create NAME [-d <value>] [-s active|inactive|archived] [-k <value>] [--json]
880
+
881
+ ARGUMENTS
882
+ NAME Project name
883
+
884
+ FLAGS
885
+ -d, --description=<value> Project description
886
+ -k, --apikey=<value> API key to use for authentication (overrides API_KEY env variable)
887
+ -s, --status=<option> [default: active] Project status
888
+ <options: active|inactive|archived>
889
+ --json Output result as JSON
890
+
891
+ DESCRIPTION
892
+ Create a new project in your organization
893
+
894
+ EXAMPLES
895
+ $ pump-cli project create "My Project"
896
+
897
+ $ pump-cli project create "Web App" --description="A web application project"
898
+
899
+ $ pump-cli project create "API Project" --description="Backend API services" --status=active
900
+
901
+ $ pump-cli project create "My Project" --json
902
+ ```
903
+
904
+ _See code: [src/commands/project/create.ts](https://github.com/pump-inc/pump-cli/blob/v0.0.1/src/commands/project/create.ts)_
905
+ <!-- commandsstop -->