cloudhub-cli
v1.0.27
Published
Use Cloudhub from the CLI
Downloads
36
Readme
CloudHub CLI shell
Display and interact with CloudHub resource from the command line. Supports interactive shell and standard CLI modes.
Installation from npm
npm install -g cloudhub-cli
Installation from source
git clone https://github.com/mulesoft/cloudhub-cli.git
cd cloudhub-cli
npm install
node src/app.js
Usage
cloudhub-cli [params] [command]
Note: Omitting the command will run cloudhub-cli in interactive mode.
Required parameters:
- username
--username <name>
orexport CLOUDHUB_USERNAME=<name>
- password
--password <pwd>
orexport CLOUDHUB_PASSWORD=<pwd>
Optional parameters:
- organization
--organization <name>
orexport CLOUDHUB_ORG=<name>
- environment
--environment <name>
orexport CLOUDHUB_ENV=<name>
- host
--host <name>
orexport CLOUDHUB_HOST=<name>
Commands
help [command...] Provides help for a given command.
exit [options] Exits cloudhub-cli
account Show account details
business-groups Lists business groups
apps Lists all applications in the environment
show <name> Show application details
json <name> Show raw application JSON response
stop <name> Stop a running application
start <name> Start an application
restart <name> Restart a running application
delete <name> Delete an application
deploy [options] <name> <zipfile> Deploy a new application
update [options] <name> [zipfile] Update an existing application, optionally updating the zip file
tail <name> Tail application logs
environments Lists environments
regions Lists all supported regions
runtimes Lists all supported runtimes
token Show API access token
create business-group <name> Create a new business group
create environment [options] <name> Create new environment
delete business-group <name> Delete existing business group
delete environment <name> Delete existing environment
Example output
> apps
┌────────────────────────────────────────┬───────────────┬──────────────────┬──────────────────┐
│ Application │ Status │ vCores │ Updated │
├────────────────────────────────────────┼───────────────┼──────────────────┼──────────────────┤
│ jeff-test-2 │ UNDEPLOYED │ 1 vCore * 1 │ 3 days ago │
│ cpu-killer.zip │ │ │ │
├────────────────────────────────────────┼───────────────┼──────────────────┼──────────────────┤
│ jeff-test-4 │ UNDEPLOYED │ 1 vCore * 1 │ 3 days ago │
│ cpu-killer.zip │ │ │ │
├────────────────────────────────────────┼───────────────┼──────────────────┼──────────────────┤
│ jeff-test │ STARTED │ 1 vCore * 2 │ a few seconds a… │
│ case36521-ch-error.zip │ │ │ │
└────────────────────────────────────────┴───────────────┴──────────────────┴──────────────────┘
> show jeff-test
┌──────────────────────────────┬──────────────────────────────────────────────────┐
│ Domain │ jeff-test.dev.cloudhub.io │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│ Status │ STARTED │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│ Updated │ a few seconds ago │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│ Runtime │ 3.6.2-R44-CI-SNAPSHOT │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│ File name │ case36521-ch-error.zip │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│ Region │ us-east-1 │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│ Persistent queues │ true │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│ Persistent queues encrypted │ false │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│ Static IPs enabled │ false │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│ Workers │ 1 vCore * 2 │
│ │ i-3837858b, STARTED │
│ │ i-a0fd1629, STARTED │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│ Properties │ environment=prod │
└──────────────────────────────┴──────────────────────────────────────────────────┘