anypoint-cli

Anypoint Platform CLI

Display and interact with the Anypoint Platform from the command line. Supports interactive shell and standard CLI modes.

Installation from npm

npm install -g anypoint-cli

Installation from source

git clone https://github.com/mulesoft/anypoint-cli.git
cd anypoint-cli
npm install
node src/app.js

Usage

anypoint-cli [params] [command]

Note: Omitting the command will run anypoint-cli in interactive mode.

Required parameters:

1. username --username <name> or export ANYPOINT_USERNAME=<name>
2. password --password <pwd> or export ANYPOINT_PASSWORD=<pwd>

Optional parameters:

1. organization --organization <name> or export ANYPOINT_ORG=<name>
2. environment --environment <name> or export ANYPOINT_ENV=<name>
3. host --host <name> or export ANYPOINT_HOST=<name>

Commands

help [command...]                                                                                      Provides help for a given command.
exit                                                                                                   Exits cloudhub-cli
account describe-me                                                                                  Show account details
account describe-business-groups                                                                     Lists business groups
account describe-business-group <name>                                                               Show details of a business group
account switch-business-group <name>                                                                 Make specified business-group active
account describe-environments                                                                        Lists environments
account use-environment <name>                                                                       Make specified environment active
account create-environments [options] <name>                                                         Create new environment
account delete-environment <name>                                                                    Delete an environment
arm describe-applications                                                                            Lists all applications in the environment
arm describe-application <name>                                                                      Show application details
arm describe-application-json <name>                                                                 Show raw application JSON response
arm stop-application <name>                                                                          Stop a running application
arm start-application <name>                                                                         Start an application
arm restart-application <name>                                                                       Restart a running application
arm delete-application <name>                                                                        Delete an application
arm deploy-application [options] <name> <zipfile>                                                    Deploy a new application
arm modify-application [options] <name> [zipfile]                                                    Modify an existing application, optionally updating the zip file
arm revert-application-runtime <name>                                                                Reverts application to its previous runtime
arm download-application-logs <name> <directory>                                                     Download application logs to specified directory
arm tail-application-logs <name>                                                                     Tail application logs
cloudhub describe-lbs                                                                                Lists all load balancers
cloudhub describe-lb-rules <name>                                                                    Lists the proxy rules for a load balancer
cloudhub add-lb-rule <name> <index> <inputSubdomain> <inputUri> <appName> <appUri>                   Adds a rule at the specified index.
cloudhub delete-lb-rule <name> <index>                                                               Delete a rule at the specified index.
cloudhub create-lb <name> <domain> <vpcId> <vpcRegion> <publicKey> <privateKey> <clientCertificate>  Creates a load balancer
cloudhub modify-lb [options] <name>                                                                  Updates a load balancer
cloudhub delete-lb <name>                                                                            Delete a load balancer
cloudhub describe-regions                                                                            Lists all supported regions
cloudhub describe-runtimes                                                                           Lists all available runtimes
cloudhub describe-vpcs                                                                               Lists all VPCs
token                                                                                                Show API access token

Example output

> arm describe-applications
┌────────────────────────────────────────┬───────────────┬──────────────────┬──────────────────┐
│ 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               │               │                  │                  │
└────────────────────────────────────────┴───────────────┴──────────────────┴──────────────────┘
> arm describe-application 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                                 │
└──────────────────────────────┴──────────────────────────────────────────────────┘