pagodabox-cli

Pagoda Box V2 CLI

Releases available for the following Operating Systems (OS) and Architectures (OSArch):

Tested:

• OSX 10.6+ (darwin) - 386 | amd64
• Linux - 386 | amd64 | arm
• Windows 98+ - 386 | amd64

Untested:

• FreeBSD - 386 | amd64 | arm
• NetBSD - 386 | amd64 | arm
• OpenBSD - 386 | amd64
• Solaris - amd64

Installation

To install the CLI first download the build that corresponds to your OS/OSArch from pagodabox.io/downloads, then depending on your OS follow the steps below.

OSX and Linux:

1. Place the binary in your $PATH (ex. ~/bin) and run chmod 755 pagoda.
2. Type pagoda and follow the instructions to authenticate the CLI with Pagoda Box.

Windows

It is highly recommended that you use git bash as your shell. Not only will this provide the git workflow you'll need for Pagoda Box, but it will also give the CLI what it needs for features such as tunneling and SSH access to servers.

1. Place the pagoda.exe file in your $PATH (ex. C:/Windows), then you can either run it by clicking on it or using a shell.

From source:

1. cd into the folder on your GOPATH where you want the project to live.
2. git clone git@github.com:pagodabox-tools/pagoda.git.
3. install gom. This is how the CLI manages dependancies. Skipping this step requires that you go get each dependancy in order to use the CLI.
4. cd into the new directory and run gom install or gom build.
5. Type cli and follow the instructions to authenticate the CLI with Pagoda Box.

Usage

Typing pagoda will show the CLI's help text and list of available commands.

Typing pagoda -v or pagoda --version will tell you what version of the CLI you are currently using, and what the latest available version is.

All commands have a short (-) and a verbose (--) option when passing flags.

Passing -h to any command returns detailed information about that command.

Passing --debug at the end of any command will show all API request/response output.

Available Commands:

• pagoda user : Display your users information.
• pagoda list : List all your applications.
• pagoda info : Display info about an application.
• pagoda create : Create an application.
• pagoda destroy : Destroy an app.
• pagoda rebuild : Rebuild and redeploy an app.
• pagoda rollback : Roll an app back one (1) deploy.
• pagoda log : Display app log information.
• pagoda run : Run a command on an app service.
• pagoda ssh : Open an SSH connection to an app service.
• pagoda tunnel : Create a port forward tunnel to an app service.
• pagoda evar:create : Create an environment variable for app
• pagoda evar:destroy : Destroy an environment variable for app
• pagoda evar:list : List all environment variable for app
• pagoda service:list : List an app's services
• pagoda service:info : List info about a service
• pagoda service:restart : Restart a service
• pagoda service:reboot : Reboot a service
• pagoda service:repair : Repair a service
• pagoda open : Open an app in the default browser.
• pagoda update : Check for updates to the CLI.

Documentation

Complete documentation is available on godoc.

Contact

For help using the CLI or if you have any questions or suggestions, please find us on IRC (freenode) at #pagodabox. We're available between 8 - 5pm MST.