@pump-inc/cli
v0.0.6
Published
Pump CLI
Readme
pump-cli
A new CLI generated with oclif
Usage
$ npm install -g @pump-inc/cli
$ pump-cli COMMAND
running command...
$ pump-cli (--version)
@pump-inc/cli/0.0.6 linux-x64 node-v24.12.0
$ pump-cli --help [COMMAND]
USAGE
$ pump-cli COMMAND
...Commands
pump-cli admin config set [VALUE]pump-cli admin organization create NAME USERIDpump-cli admin organization get ORGANIZATIONIDpump-cli admin organization listpump-cli admin user create NAME EMAILpump-cli api-key create NAMEpump-cli api-key delete IDpump-cli api-key listpump-cli api-key update IDpump-cli app create NAMEpump-cli app deploy [FILE]pump-cli app list [FILE]pump-cli app secrets APPLICATIONIDpump-cli app status [APPLICATIONID]pump-cli app stoppump-cli app usage [APPLICATIONID]pump-cli auth testpump-cli config validate [FILE]pump-cli help [COMMAND]pump-cli pluginspump-cli plugins add PLUGINpump-cli plugins:inspect PLUGIN...pump-cli plugins install PLUGINpump-cli plugins link PATHpump-cli plugins remove [PLUGIN]pump-cli plugins resetpump-cli plugins uninstall [PLUGIN]pump-cli plugins unlink [PLUGIN]pump-cli plugins updatepump-cli project create NAME
pump-cli admin config set [VALUE]
This command is used to set global configuration keys in the DB (admin only)
USAGE
$ pump-cli admin config set [VALUE] [-k <value>] [-u <value>] [-c <value>]
ARGUMENTS
[VALUE] value to set
FLAGS
-c, --key=<value> key to set
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
DESCRIPTION
This command is used to set global configuration keys in the DB (admin only)
EXAMPLES
$ pump-cli admin config setSee code: src/commands/admin/config/set.ts
pump-cli admin organization create NAME USERID
Create a new organization (admin only)
USAGE
$ pump-cli admin organization create NAME USERID [-k <value>] [-u <value>] [-j] [-d <value>] [-D <value>] [-s]
ARGUMENTS
NAME Organization name
USERID User ID to be set as organization owner
FLAGS
-D, --domain=<value> Organization domain name
-d, --description=<value> Organization description
-j, --json Output as JSON
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-s, --skipReconcilerJob Skip creating reconciler job for this organization
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
DESCRIPTION
Create a new organization (admin only)
EXAMPLES
$ pump-cli admin organization create "Acme Corp" user_1234567890
$ pump-cli admin organization create "Tech Startup" user_1234567890 --description="A cutting-edge technology company"
$ pump-cli admin organization create "Enterprise Ltd" user_1234567890 --description="Enterprise solutions" --domain="enterprise.com"
$ pump-cli admin organization create "Quick Org" user_1234567890 --skipReconcilerJob
$ pump-cli admin organization create "Json Org" user_1234567890 --jsonSee code: src/commands/admin/organization/create.ts
pump-cli admin organization get ORGANIZATIONID
Get organization details with owner and members (admin only)
USAGE
$ pump-cli admin organization get ORGANIZATIONID [-k <value>] [-u <value>] [-j] [-m]
ARGUMENTS
ORGANIZATIONID Organization ID to retrieve
FLAGS
-j, --json Output as JSON
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-m, --membersOnly Show only members information
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
DESCRIPTION
Get organization details with owner and members (admin only)
EXAMPLES
$ pump-cli admin organization get org_1234567890
$ pump-cli admin organization get org_1234567890 --json
$ pump-cli admin organization get org_1234567890 --members-onlySee code: src/commands/admin/organization/get.ts
pump-cli admin organization list
List all organizations (admin only)
USAGE
$ pump-cli admin organization list [-k <value>] [-u <value>] [-j] [-s name|created|members] [-d]
FLAGS
-d, --desc Sort in descending order
-j, --json Output as JSON
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-s, --sortBy=<option> [default: name] Sort by field
<options: name|created|members>
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
DESCRIPTION
List all organizations (admin only)
EXAMPLES
$ pump-cli admin organization list
$ pump-cli admin organization list --json
$ pump-cli admin organization list --sort-by=name
$ pump-cli admin organization list --sort-by=created --descSee code: src/commands/admin/organization/list.ts
pump-cli admin user create NAME EMAIL
Create a new user (admin only)
USAGE
$ pump-cli admin user create NAME EMAIL [-k <value>] [-u <value>] [-j] [-a] [-v] [-i <value>]
ARGUMENTS
NAME User's full name
EMAIL User's email address
FLAGS
-a, --admin Make the user an admin
-i, --image=<value> User's profile image URL
-j, --json Output as JSON
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
-v, --verified Mark the user's email as verified
DESCRIPTION
Create a new user (admin only)
EXAMPLES
$ pump-cli admin user create "John Doe" [email protected]
$ pump-cli admin user create "Jane Admin" [email protected] --admin
$ pump-cli admin user create "Bob User" [email protected] --admin --verified --image="https://example.com/avatar.jpg"
$ pump-cli admin user create "Json User" [email protected] --jsonSee code: src/commands/admin/user/create.ts
pump-cli api-key create NAME
Create a new API key for your organization
USAGE
$ pump-cli api-key create NAME [-k <value>] [-u <value>] [-d <value>] [-s
active|inactive|revoked|pending|suspended]
ARGUMENTS
NAME API key name
FLAGS
-d, --description=<value> API key description
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-s, --status=<option> [default: active] API key status
<options: active|inactive|revoked|pending|suspended>
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
DESCRIPTION
Create a new API key for your organization
EXAMPLES
$ pump-cli api-key create "My API Key"
$ pump-cli api-key create "Production API" --description="For production use" --status=active
$ pump-cli api-key create "Test Key" --description="Temporary test key" --status=pendingSee code: src/commands/api-key/create.ts
pump-cli api-key delete ID
Delete an API key
USAGE
$ pump-cli api-key delete ID [-k <value>] [-u <value>] [-f]
ARGUMENTS
ID API key ID to delete
FLAGS
-f, --force Skip confirmation prompt
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
DESCRIPTION
Delete an API key
EXAMPLES
$ pump-cli api-key delete abc-123
$ pump-cli api-key delete abc-123 --forceSee code: src/commands/api-key/delete.ts
pump-cli api-key list
List all API keys for your organization
USAGE
$ pump-cli api-key list [-k <value>] [-u <value>] [-j] [-s active|inactive|revoked|pending|suspended]
FLAGS
-j, --json Output as JSON
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-s, --status=<option> Filter by status
<options: active|inactive|revoked|pending|suspended>
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
DESCRIPTION
List all API keys for your organization
EXAMPLES
$ pump-cli api-key list
$ pump-cli api-key list --json
$ pump-cli api-key list --status=activeSee code: src/commands/api-key/list.ts
pump-cli api-key update ID
Update an existing API key
USAGE
$ pump-cli api-key update ID [-k <value>] [-u <value>] [-n <value>] [-d <value>] [-s
active|inactive|revoked|pending|suspended]
ARGUMENTS
ID API key ID to update
FLAGS
-d, --description=<value> New API key description
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-n, --name=<value> New API key name
-s, --status=<option> New API key status
<options: active|inactive|revoked|pending|suspended>
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
DESCRIPTION
Update an existing API key
EXAMPLES
$ pump-cli api-key update abc-123 --name="Updated Name"
$ pump-cli api-key update abc-123 --description="New description" --status=inactive
$ pump-cli api-key update abc-123 --status=revokedSee code: src/commands/api-key/update.ts
pump-cli app create NAME
Create a new application
USAGE
$ pump-cli app create NAME -p <value> [-k <value>] [-u <value>] [-t processor|cron] [-s
pending|active|inactive] [--cpu <value>] [--memory <value>] [--storage <value>] [--network <value>] [--json]
ARGUMENTS
NAME Application name
FLAGS
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-p, --project-id=<value> (required) Project ID where the application will be created
-s, --status=<option> [default: pending] Application status
<options: pending|active|inactive>
-t, --type=<option> [default: processor] Application type
<options: processor|cron>
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
--cpu=<value> CPU resources (cores)
--json Output result as JSON
--memory=<value> Memory resources (MB)
--network=<value> Network resources (Mbps)
--storage=<value> Storage resources (GB)
DESCRIPTION
Create a new application
EXAMPLES
$ pump-cli app create "My App" --project-id=proj-123 --type=processor
$ pump-cli app create "API Service" --project-id=proj-456 --type=processor --cpu=1 --memory=512
$ pump-cli app create "Worker" --project-id=proj-789 --type=cron --cpu=2 --status=active
$ pump-cli app create "My App" --project-id=proj-123 --type=processor --jsonSee code: src/commands/app/create.ts
pump-cli app deploy [FILE]
Deploy an application by providing a config file
USAGE
$ pump-cli app deploy [FILE] -a <value> [-k <value>] [-u <value>] [-f] [-n <value>] [--json]
ARGUMENTS
[FILE] file to read
FLAGS
-a, --appId=<value> (required) [env: PUMPINC_APP_ID] application id to deploy
-f, --force
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-n, --name=<value> Deployment name
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
--json Output result as JSON
DESCRIPTION
Deploy an application by providing a config file
EXAMPLES
$ pump-cli app deploy config-file.yamlSee code: src/commands/app/deploy.ts
pump-cli app list [FILE]
describe the command here
USAGE
$ pump-cli app list [FILE] [-k <value>] [-u <value>] [-v]
ARGUMENTS
[FILE] file to read
FLAGS
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
-v, --verbose Show detailed application info
DESCRIPTION
describe the command here
EXAMPLES
$ pump-cli app listSee code: src/commands/app/list.ts
pump-cli app secrets APPLICATIONID
List all secrets for an application
USAGE
$ pump-cli app secrets APPLICATIONID [-k <value>] [-u <value>]
ARGUMENTS
APPLICATIONID Application ID to list secrets for
FLAGS
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
DESCRIPTION
List all secrets for an application
EXAMPLES
$ pump-cli app secrets app_12345
$ pump-cli app secrets app_12345 -k your-api-keySee code: src/commands/app/secrets.ts
pump-cli app status [APPLICATIONID]
Get the status of a specific application by its ID
USAGE
$ pump-cli app status [APPLICATIONID] [-k <value>] [-u <value>]
ARGUMENTS
[APPLICATIONID] Application ID to get status for eg. app_1234567890abcdef
FLAGS
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
DESCRIPTION
Get the status of a specific application by its ID
EXAMPLES
$ pump-cli app statusSee code: src/commands/app/status.ts
pump-cli app stop
Stop the running deployment for an application
USAGE
$ pump-cli app stop -a <value> [-k <value>] [-u <value>] [--json]
FLAGS
-a, --appId=<value> (required) [env: PUMPINC_APP_ID] application id to stop deployment for
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
--json Output result as JSON
DESCRIPTION
Stop the running deployment for an application
EXAMPLES
$ pump-cli app stop --appId <application-id>See code: src/commands/app/stop.ts
pump-cli app usage [APPLICATIONID]
get usage information for an application including execution units and CPU/memory usage
USAGE
$ pump-cli app usage [APPLICATIONID] [-k <value>] [-u <value>] [-h]
ARGUMENTS
[APPLICATIONID] application ID to get usage for
FLAGS
-h, --hide hide deployment details
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
DESCRIPTION
get usage information for an application including execution units and CPU/memory usage
EXAMPLES
$ pump-cli app usage app_aaaabbbbccccddddeeeeSee code: src/commands/app/usage.ts
pump-cli auth test
Test API authentication with the configured API key
USAGE
$ pump-cli auth test [-k <value>] [-u <value>] [-v]
FLAGS
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
-v, --verbose Show detailed authentication information
DESCRIPTION
Test API authentication with the configured API key
EXAMPLES
$ pump-cli auth test
$ pump-cli auth test --verboseSee code: src/commands/auth/test.ts
pump-cli config validate [FILE]
validate a config file
USAGE
$ pump-cli config validate [FILE] [-k <value>] [-u <value>]
ARGUMENTS
[FILE] file to read
FLAGS
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
DESCRIPTION
validate a config file
EXAMPLES
$ pump-cli config validate <file>See code: src/commands/config/validate.ts
pump-cli help [COMMAND]
Display help for pump-cli.
USAGE
$ pump-cli help [COMMAND...] [-n]
ARGUMENTS
[COMMAND...] Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for pump-cli.See code: @oclif/plugin-help
pump-cli plugins
List installed plugins.
USAGE
$ pump-cli plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ pump-cli pluginsSee code: @oclif/plugin-plugins
pump-cli plugins add PLUGIN
Installs a plugin into pump-cli.
USAGE
$ pump-cli plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into pump-cli.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the PUMP_CLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the PUMP_CLI_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ pump-cli plugins add
EXAMPLES
Install a plugin from npm registry.
$ pump-cli plugins add myplugin
Install a plugin from a github url.
$ pump-cli plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ pump-cli plugins add someuser/somepluginpump-cli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ pump-cli plugins inspect PLUGIN...
ARGUMENTS
PLUGIN... [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ pump-cli plugins inspect mypluginSee code: @oclif/plugin-plugins
pump-cli plugins install PLUGIN
Installs a plugin into pump-cli.
USAGE
$ pump-cli plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into pump-cli.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the PUMP_CLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the PUMP_CLI_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ pump-cli plugins add
EXAMPLES
Install a plugin from npm registry.
$ pump-cli plugins install myplugin
Install a plugin from a github url.
$ pump-cli plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ pump-cli plugins install someuser/somepluginSee code: @oclif/plugin-plugins
pump-cli plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ pump-cli plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ pump-cli plugins link mypluginSee code: @oclif/plugin-plugins
pump-cli plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ pump-cli plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
[PLUGIN...] plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ pump-cli plugins unlink
$ pump-cli plugins remove
EXAMPLES
$ pump-cli plugins remove mypluginpump-cli plugins reset
Remove all user-installed and linked plugins.
USAGE
$ pump-cli plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.See code: @oclif/plugin-plugins
pump-cli plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ pump-cli plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
[PLUGIN...] plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ pump-cli plugins unlink
$ pump-cli plugins remove
EXAMPLES
$ pump-cli plugins uninstall mypluginSee code: @oclif/plugin-plugins
pump-cli plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ pump-cli plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
[PLUGIN...] plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ pump-cli plugins unlink
$ pump-cli plugins remove
EXAMPLES
$ pump-cli plugins unlink mypluginpump-cli plugins update
Update installed plugins.
USAGE
$ pump-cli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
pump-cli project create NAME
Create a new project in your organization
USAGE
$ pump-cli project create NAME [-k <value>] [-u <value>] [-d <value>] [-s active|inactive|archived] [--json]
ARGUMENTS
NAME Project name
FLAGS
-d, --description=<value> Project description
-k, --apikey=<value> [env: API_KEY] API key to use for authentication (overrides API_KEY env variable)
-s, --status=<option> [default: active] Project status
<options: active|inactive|archived>
-u, --apiUrl=<value> [env: PUMP_API_URL] API URL to use for requests (overrides PUMP_API_URL env variable)
--json Output result as JSON
DESCRIPTION
Create a new project in your organization
EXAMPLES
$ pump-cli project create "My Project"
$ pump-cli project create "Web App" --description="A web application project"
$ pump-cli project create "API Project" --description="Backend API services" --status=active
$ pump-cli project create "My Project" --jsonSee code: src/commands/project/create.ts
