The Aptible CLI is a command line interface to access your Aptible resources. For a detailed list of what features the provider supports see the Feature Support Matrix.

Installation on macOS

Download v0.19.6 for macOS ↓

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

brew install --cask aptible

Installation on Windows

Download v0.19.6 for Windows ↓

Installation on Debian

Download v0.19.6 for Debian ↓

Installation on Ubuntu

Download v0.19.6 for Ubuntu ↓

Installation on CentOS

Download v0.19.6 for CentOS ↓

MFA support

In order to use hardware-based MFA (e.g. Yubikey) on Windows and Linux, you will need to manually install the libfido2 command line tools. You can find the latest installation release and installation instructions here here.

For OSX users, installation via Homebrew will automatically include the libfido2 dependency.

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.

Configuration location

The Aptible CLI normally stores its configuration (your Aptible authentication token and automatically generated SSH keys) in a hidden subfolder 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!

Commands

• aptible apps:create
• aptible apps:deprovision
• aptible apps:rename
• aptible apps:scale
• aptible apps
• aptible backup:list
• aptible backup:orphaned
• aptible backup:purge
• aptible backup:restore
• aptible config:add
• aptible config:rm
• aptible config:set
• aptible config:unset
• aptible config
• aptible db:backup
• aptible db:clone
• aptible db:create
• aptible db:deprovision
• aptible db:dump
• aptible db:execute
• aptible db:list
• aptible db:modify
• aptible db:reload
• aptible db:rename
• aptible db:replicate
• aptible db:restart
• aptible db:tunnel
• aptible db:url
• aptible db:versions
• aptible deploy
• aptible domains
• aptible endpoints:database:create
• aptible endpoints:database:modify
• aptible endpoints:deprovision
• aptible endpoints:https:create
• aptible endpoints:https:modify
• aptible endpoints:list
• aptible endpoints:renew
• aptible endpoints:tcp:create
• aptible endpoints:tcp:modify
• aptible endpoints:tls:create
• aptible endpoints:tls:modify
• aptible environment:ca_cert
• aptible environment:list
• aptible environment:rename
• aptible help
• aptible log_drain:create:datadog
• aptible log_drain:create:elasticsearch
• aptible log_drain:create:https
• aptible log_drain:create:logdna
• aptible log_drain:create:papertrail
• aptible log_drain:create:sumologic
• aptible log_drain:create:syslog
• aptible log_drain:deprovision
• aptible log_drain:list
• aptible login
• aptible logs_from_archive
• aptible logs
• aptible metric_drain:create:datadog
• aptible metric_drain:create:influxdb:custom
• aptible metric_drain:create:influxdb
• aptible metric_drain:deprovision
• aptible metric_drain:list
• aptible operation:cancel
• aptible operation:follow
• aptible operation:logs
• aptible rebuild
• aptible restart
• aptible services
• aptible ssh
• aptible version