Installing the CLI

The cx Command Line Interface (CLI) is a tool to manage apps on your computer and in the cloud.

Install the CLI

  1. MacOS
  2. Linux
  3. Windows
  1. MacOS

    $ curl -o /usr/local/bin/cx
    $ chmod +x /usr/local/bin/cx
  2. Linux

    $ curl -o /usr/local/bin/cx
    $ chmod +x /usr/local/bin/cx
  3. Windows

    Not yet supported. Contact to discuss.

Update the CLI

Confirm that cx is correctly installed and up to date:

$ cx update
updating cli to 20170628170448: OK


You can see how to use the CLI with the cx help or --help flag:

$ cx help
cx: convox management tool

cx <command> [args...]

Subcommands: (cx help <subcommand>)
apps        list applications
builds      list builds
deploy      build and promote an application
env         display current env
logs        show app logs
ps          list processes
releases    list releases
resources   list resources
run         run a new process
services    list services
start       start the app in development mode
test        run tests

--app value   app name
--rack value  rack name
--version     print the version

Bash Helper

You can configure your bash terminal to display what rack you are pointing to by adding the following to ~/.bash_profile:

export PS1="\h:\W \u (\$(cx switch))$ "
Laptop:docs noah (local)$ 
$ cx apps
docs  running

$ cx switch convox/production
Laptop:docs noah (convox/production)$ 

$ cx apps
NAME             STATUS
docs-production  running