Aptible CLI
Command-line interface for Aptible services.
Installation
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
.
Usage
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 TYPE NUMBER # Scale app to NUMBER of instances
aptible config # Print an app's current configuration
aptible config:add # Add an ENV variable to an app
aptible config:rm # Remove an ENV variable from an app
aptible config:set # Alias for config:add
aptible config:unset # Alias for config:rm
aptible db:clone SOURCE DEST # Clone a database to create a new one
aptible db:create HANDLE # Create a new database
aptible db:deprovision HANDLE # Deprovision a database
aptible db:dump HANDLE # Dump a remote database to file
aptible db:execute HANDLE SQL_FILE # Executes sql against a database
aptible db:list # List all databases
aptible db:tunnel HANDLE # Create a local tunnel to a database
aptible domains # Print an app's current virtual domains
aptible help [COMMAND] # Describe available commands or one specific command
aptible login # Log in to Aptible
aptible logs # Follows logs from a running app
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 ssh [COMMAND] # Run a command against an app
aptible version # Print Aptible CLI version
Contributing
- 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, update this README with the output of
aptible help | grep -v help
. - Create a new pull request on GitHub.
Contributors
- Frank Macreery (@fancyremarker)
- Graham Melcher (@melcher)
- Pete Browne (@petebrowne)
- Rich Humphrey (@rdh)
- Daniel Levenson (@dleve123)
- Ryan Aipperspach (@ryanaip)
- Chas Ballew (@chasballew)
Copyright and License
MIT License, see LICENSE for details.
Copyright (c) 2016 Aptible and contributors.