The Aptible CLI is a command line interface to access your Aptible resources.
Or, if you’re using OSX, you can also install the Aptible CLI using Homebrew:
brew install --cask aptible
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
APTIBLE_OUTPUT_FORMAT variable is left unset (i.e. the default), the CLI will provide output as plain text.
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
stdoutthrough, which is exactly what you want here.
The Aptible CLI normally stores its configuration (your Aptible authentication token and automatically generated SSH keys) in a hidden sub-folder of your home directory:
~/.aptible. To override this default location, you can specify a custom path by using the environment variable
APTIBLE_CONFIG_PATH. Since the files in this path grant access to your Aptible account, protect them as if they were your password itself!
Updated 23 days ago