heroku-config

Provides a way for you to push/pull your Heroku environment to use locally.

Installation

Add the heroku gem plugin:

$ heroku plugins:install git://github.com/ddollar/heroku-config.git
heroku-config installed

Add the following to .gitignore:

.env

Usage

# by default, all existing keys will not be overwritten
$ heroku config:pull
Config for example written to .env

# optional --overwrite allows you to have the pull overwrite keys
$ heroku config:pull --overwrite
Config for example written to .env

# optionally you can specify what keys to pull
$ heroku config:pull S3_BUCKET S3_KEY S3_SECRET
Config in example written to .env

# --interactive will prompt for each value to be overwritten
$ heroku config:pull --overwrite --interactive
BUNDLE_DISABLE_SHARED_GEMS: 1
Overwite? (y/N)

$ heroku config:push
Config in .env written to example

# Optional --env will use specific env file
$ heroku config:pull --env=production.env
Config for example written to production.env

# --quiet will suppress normal output to stdout
$ heroku config:pull --overwrite --quiet
(outputs nothing)

# Pipe keys to STDOUT
$ heroku config:pull > config/production.env

# Pipe keys from STDIN
$ cat config/production.env | heroku config:push

How it works

Your environment will be stored locally in a file named .env. This file can be read by foreman to load the local environment for your app.

To use a file other than the default .env, use the --env parameter.

Please remember to not commit your .env files to your repository.

License

MIT License

Author

David Dollar ddollar@gmail.com

rcaught / heroku-config