README.md

Heroku API - deploy apps to Heroku from the command line

This library wraps the REST API for managing and deploying Rails apps to the Heroku platform. It can be called as a Ruby library, or invoked from the command line. Code push and pull is done through Git.

For more about Heroku see http://heroku.com.

For full documentation see http://heroku.com/docs.

Sample Workflow

Create a new Rails app and deploy it:

rails myapp && cd myapp   # Create an app
git init                  # Init git repository
git add .                 # Add everything
git commit -m Initial     # Commit everything
heroku create             # Create your app on Heroku
git push heroku master    # Deploy your app on Heroku

Setup

gem install heroku

If you wish to push or pull code, you must also have a working install of Git ("apt-get install git-core" on Ubuntu or "port install git-core" on OS X), and an ssh public key ("ssh-keygen -t rsa").

The first time you run a command, such as "heroku list," you will be prompted for your Heroku username and password. Your API key will be fetched and stored locally to authenticate future requests.

Your public key (~/.ssh/id_[rd]sa.pub) will be uploaded to Heroku after you enter your credentials. Use heroku keys:add if you wish to upload additional keys or specify a key in a non-standard location.

Meta

Created by Adam Wiggins

Maintained by David Dollar

Patches contributed by:

• Adam McCrea [email protected]
• Adam Wiggins [email protected]
• Ben [email protected]
• Blake Mizerany [email protected]
• Caio Chassot [email protected]
• Charles Roper [email protected]
• Chris O'Sullivan [email protected]
• Daniel Farina [email protected]
• David Dollar [email protected]
• Denis Barushev [email protected]
• Eric Anderson [email protected]
• Glenn Gillen [email protected]
• James Lindenbaum [email protected]
• Joshua Peek [email protected]
• Julien Kirch [email protected]
• Larry Marburger [email protected]
• Les Hill [email protected]
• Les Hill and Veez (Matt Remsik) [email protected]
• Mark McGranaghan [email protected]
• Matt Buck [email protected]
• Morten Bagai [email protected]
• Nick Quaranto [email protected]
• Noah Zoschke [email protected]
• Pedro Belo [email protected]
• Peter Theill [email protected]
• Peter van Hardenberg [email protected]
• Ricardo Chimal, Jr [email protected]
• Ryan R. Smith [email protected]
• Ryan Tomayko [email protected]
• Sarah Mei [email protected]
• SixArm [email protected]
• Terence Lee [email protected]
• Trevor Turk [email protected]
• Will Leinweber [email protected]
• pipa [email protected]

Released under the MIT license.