Aptible CLI

The Aptible CLI is a command line interface to access your Aptible resources.

Installation

To install the CLI, download it from our website.

Tip

If you’re using OSX, you can also install the Aptible CLI using Homebrew:

brew cask install aptible

Output Format

The Aptible CLI supports two output formats: plain text and JSON. You can select your preferred output format by setting the APTIBLE_OUTPUT_FORMAT environment variable to text or json.

If the APTIBLE_OUTPUT_FORMAT variable is left unset (i.e. the default), the CLI will provide output as plain text.

Tip

The Aptible CLI sends logging output to stderr, and everything else to stdout (this is the standard behavior for well-behaved UNIX programs).

If you’re calling the Aptible CLI from another program, make sure you don’t merge the two streams (if you did, you’d have to filter out the logging output).

Note that if you’re simply using a shell such as Bash, the pipe operator (i.e. |) only pipes stdout through, which is exactly what you want here.