Skip to content

Latest commit

 

History

History
174 lines (123 loc) · 4.14 KB

config.md

File metadata and controls

174 lines (123 loc) · 4.14 KB
Raw

heroku config

environment variables of apps

heroku config

display the config vars for an app

USAGE
  $ heroku config -a <value> [-r <value>] [-s] [-j]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -j, --json            output config vars in json format
  -r, --remote=<value>  git remote of app to use
  -s, --shell           output config vars in shell format

DESCRIPTION
  display the config vars for an app

See code: src/commands/config/index.ts

heroku config:edit [KEY]

interactively edit config vars

USAGE
  $ heroku config:edit [KEY] -a <value> [-r <value>]

ARGUMENTS
  KEY  edit a single key

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  interactively edit config vars
  This command opens the app config in a text editor set by $VISUAL or $EDITOR.
  Any variables added/removed/changed will be updated on the app after saving and closing the file.

EXAMPLES
  # edit with vim
  $ EDITOR="vim" heroku config:edit

  # edit with emacs
  $ EDITOR="emacs" heroku config:edit

  # edit with pico
  $ EDITOR="pico" heroku config:edit

  # edit with atom editor
  $ VISUAL="atom --wait" heroku config:edit

See code: src/commands/config/edit.ts

heroku config:get KEY...

display a single config value for an app

USAGE
  $ heroku config:get KEY...

ARGUMENTS
  KEY...  key name of the config var value

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use
  -s, --shell           output config vars in shell format

DESCRIPTION
  display a single config value for an app

EXAMPLES
  $ heroku config:get RAILS_ENV
  production

See code: src/commands/config/get.ts

heroku config:remove

unset one or more config vars

USAGE
  $ heroku config:remove -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  unset one or more config vars

ALIASES
  $ heroku config:remove

EXAMPLES
  $ heroku config:unset RAILS_ENV
  Unsetting RAILS_ENV and restarting example... done, v10

  $ heroku config:unset RAILS_ENV RACK_ENV
  Unsetting RAILS_ENV, RACK_ENV and restarting example... done, v10

heroku config:set

set one or more config vars

USAGE
  $ heroku config:set -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  set one or more config vars

EXAMPLES
  $ heroku config:set RAILS_ENV=staging
  Setting config vars and restarting example... done, v10
  RAILS_ENV: staging
  $ heroku config:set RAILS_ENV=staging RACK_ENV=staging
  Setting config vars and restarting example... done, v11
  RAILS_ENV: staging
  RACK_ENV:  staging

See code: src/commands/config/set.ts

heroku config:unset

unset one or more config vars

USAGE
  $ heroku config:unset -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  unset one or more config vars

ALIASES
  $ heroku config:remove

EXAMPLES
  $ heroku config:unset RAILS_ENV
  Unsetting RAILS_ENV and restarting example... done, v10

  $ heroku config:unset RAILS_ENV RACK_ENV
  Unsetting RAILS_ENV, RACK_ENV and restarting example... done, v10

See code: src/commands/config/unset.ts