Command-line interface for Aptible services.
NOTE: To install the aptible tool as a system-level binary, Aptible
recommends you install the
Aptible Toolbelt, which is faster
and more robust.
Add the following line to your application's Gemfile.
gem 'aptible-cli'
And then run bundle install.
From aptible help:
Commands:
aptible apps # List all applications
aptible apps:create HANDLE # Create a new application
aptible apps:deprovision # Deprovision an app
aptible apps:scale SERVICE [--container-count COUNT] [--container-size SIZE_MB] # Scale a service
aptible backup:list DB_HANDLE # List backups for a database
aptible backup:orphaned # List backups associated with deprovisioned databases
aptible backup:purge BACKUP_ID # Permanently delete a backup and any copies of it
aptible backup:restore BACKUP_ID [--environment ENVIRONMENT_HANDLE] [--handle HANDLE] [--container-size SIZE_MB] [--disk-size SIZE_GB] [--key-arn KEY_ARN] # Restore a backup
aptible config # Print an app's current configuration
aptible config:add [VAR1=VAL1] [VAR2=VAL2] [...] # Add an ENV variable to an app
aptible config:rm [VAR1] [VAR2] [...] # Remove an ENV variable from an app
aptible config:set [VAR1=VAL1] [VAR2=VAL2] [...] # Add an ENV variable to an app
aptible config:unset [VAR1] [VAR2] [...] # Remove an ENV variable from an app
aptible db:backup HANDLE # Backup a database
aptible db:clone SOURCE DEST # Clone a database to create a new one
aptible db:create HANDLE [--type TYPE] [--version VERSION] [--container-size SIZE_MB] [--disk-size SIZE_GB] [--key-arn KEY_ARN] # Create a new database
aptible db:deprovision HANDLE # Deprovision a database
aptible db:dump HANDLE [pg_dump options] # Dump a remote database to file
aptible db:execute HANDLE SQL_FILE [--on-error-stop] # Executes sql against a database
aptible db:list # List all databases
aptible db:reload HANDLE # Reload a database
aptible db:replicate HANDLE REPLICA_HANDLE [--container-size SIZE_MB] [--disk-size SIZE_GB] [--logical --version VERSION] [--key-arn KEY_ARN] # Create a replica/follower of a database
aptible db:restart HANDLE [--container-size SIZE_MB] [--disk-size SIZE_GB] # Restart a database
aptible db:tunnel HANDLE # Create a local tunnel to a database
aptible db:url HANDLE # Display a database URL
aptible db:versions # List available database versions
aptible deploy [OPTIONS] [VAR1=VAL1] [VAR2=VAL2] [...] # Deploy an app
aptible domains # Print an app's current virtual domains - DEPRECATED
aptible endpoints:database:create DATABASE # Create a Database Endpoint
aptible endpoints:deprovision [--app APP | --database DATABASE] ENDPOINT_HOSTNAME # Deprovision an App or Database Endpoint
aptible endpoints:https:create [--app APP] SERVICE # Create an App HTTPS Endpoint
aptible endpoints:https:modify [--app APP] ENDPOINT_HOSTNAME # Modify an App HTTPS Endpoint
aptible endpoints:list [--app APP | --database DATABASE] # List Endpoints for an App or Database
aptible endpoints:renew [--app APP] ENDPOINT_HOSTNAME # Renew an App Managed TLS Endpoint
aptible endpoints:tcp:create [--app APP] SERVICE # Create an App TCP Endpoint
aptible endpoints:tcp:modify [--app APP] ENDPOINT_HOSTNAME # Modify an App TCP Endpoint
aptible endpoints:tls:create [--app APP] SERVICE # Create an App TLS Endpoint
aptible endpoints:tls:modify [--app APP] ENDPOINT_HOSTNAME # Modify an App TLS Endpoint
aptible environment:ca_cert # Retrieve the CA certificate associated with the environment
aptible environment:list # List all environments
aptible help [COMMAND] # Describe available commands or one specific command
aptible login # Log in to Aptible
aptible logs [--app APP | --database DATABASE] # Follows logs from a running app or database
aptible operation:cancel OPERATION_ID # Cancel a running operation
aptible ps # Display running processes for an app - DEPRECATED
aptible rebuild # Rebuild an app, and restart its services
aptible restart # Restart all services associated with an app
aptible services # List Services for an App
aptible ssh [COMMAND] # Run a command against an app
aptible version # Print Aptible CLI version
By default, the Aptible CLI outputs data as unstructured text, designed for human consumption.
If you need to parse the output in another program, set the APTIBLE_OUTPUT_FORMAT environment variable to json when calling the Aptible CLI for JSON output.
The default format is text.
- Fork the project.
- Commit your changes, with specs.
- Ensure that your code passes specs (
rake spec) and meets Aptible's Ruby style guide (rake rubocop). - If you add a command, sync this README (
bundle exec script/sync-readme-usage). - Create a new pull request on GitHub.
- Frank Macreery (@fancyremarker)
- Graham Melcher (@melcher)
- Pete Browne (@petebrowne)
- Rich Humphrey (@rdh)
- Daniel Levenson (@dleve123)
- Ryan Aipperspach (@ryanaip)
- Chas Ballew (@chasballew)
- Chet Bortz (@cbortz)
MIT License, see LICENSE for details.
Copyright (c) 2019 Aptible and contributors.