1 | @heroku-cli/plugin-config
|
2 | =========================
|
3 |
|
4 |
|
5 |
|
6 | [![Version](https://img.shields.io/npm/v/@heroku-cli/plugin-config.svg)](https://npmjs.org/package/@heroku-cli/plugin-config)
|
7 | [![CircleCI](https://circleci.com/gh/heroku/heroku-cli-plugin-config/tree/master.svg?style=shield)](https://circleci.com/gh/heroku/heroku-cli-plugin-config/tree/master)
|
8 | [![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/heroku/heroku-cli-plugin-config?branch=master&svg=true)](https://ci.appveyor.com/project/heroku/heroku-cli-plugin-config/branch/master)
|
9 | [![Codecov](https://codecov.io/gh/heroku/heroku-cli-plugin-config/branch/master/graph/badge.svg)](https://codecov.io/gh/heroku/heroku-cli-plugin-config)
|
10 | [![Downloads/week](https://img.shields.io/npm/dw/@heroku-cli/plugin-config.svg)](https://npmjs.org/package/@heroku-cli/plugin-config)
|
11 | [![License](https://img.shields.io/npm/l/@heroku-cli/plugin-config.svg)](https://github.com/heroku/heroku-cli-plugin-config/blob/master/package.json)
|
12 |
|
13 |
|
14 | * [Usage](#usage)
|
15 | * [Commands](#commands)
|
16 |
|
17 | # Usage
|
18 |
|
19 | ```sh-session
|
20 | $ npm install -g @heroku-cli/plugin-config
|
21 | $ heroku COMMAND
|
22 | running command...
|
23 | $ heroku (-v|--version|version)
|
24 | @heroku-cli/plugin-config/7.5.6 darwin-x64 node-v10.5.0
|
25 | $ heroku --help [COMMAND]
|
26 | USAGE
|
27 | $ heroku COMMAND
|
28 | ...
|
29 | ```
|
30 |
|
31 | # Commands
|
32 |
|
33 | * [`heroku config`](#heroku-config)
|
34 | * [`heroku config:edit [KEY]`](#heroku-configedit-key)
|
35 | * [`heroku config:get KEY...`](#heroku-configget-key)
|
36 | * [`heroku config:unset`](#heroku-configunset)
|
37 |
|
38 | ## `heroku config`
|
39 |
|
40 | display the config vars for an app
|
41 |
|
42 | ```
|
43 | USAGE
|
44 | $ heroku config
|
45 |
|
46 | OPTIONS
|
47 | -a, --app=app (required) app to run command against
|
48 | -j, --json output config vars in json format
|
49 | -r, --remote=remote git remote of app to use
|
50 | -s, --shell output config vars in shell format
|
51 | ```
|
52 |
|
53 | _See code: [src/commands/config/index.ts](https://github.com/heroku/cli/blob/v7.5.6/packages/config/src/commands/config/index.ts)_
|
54 |
|
55 | ## `heroku config:edit [KEY]`
|
56 |
|
57 | interactively edit config vars
|
58 |
|
59 | ```
|
60 | USAGE
|
61 | $ heroku config:edit [KEY]
|
62 |
|
63 | ARGUMENTS
|
64 | KEY edit a single key
|
65 |
|
66 | OPTIONS
|
67 | -a, --app=app (required) app to run command against
|
68 | -r, --remote=remote git remote of app to use
|
69 |
|
70 | DESCRIPTION
|
71 | This command opens the app config in a text editor set by $VISUAL or $EDITOR.
|
72 | Any variables added/removed/changed will be updated on the app after saving and closing the file.
|
73 |
|
74 | EXAMPLES
|
75 | # edit with vim
|
76 | $ EDITOR="vim" heroku config:edit
|
77 | # edit with emacs
|
78 | $ EDITOR="emacs" heroku config:edit
|
79 | # edit with pico
|
80 | $ EDITOR="pico" heroku config:edit
|
81 | # edit with atom editor
|
82 | $ VISUAL="atom --wait" heroku config:edit
|
83 | ```
|
84 |
|
85 | _See code: [src/commands/config/edit.ts](https://github.com/heroku/cli/blob/v7.5.6/packages/config/src/commands/config/edit.ts)_
|
86 |
|
87 | ## `heroku config:get KEY...`
|
88 |
|
89 | display a single config value for an app
|
90 |
|
91 | ```
|
92 | USAGE
|
93 | $ heroku config:get KEY...
|
94 |
|
95 | OPTIONS
|
96 | -a, --app=app (required) app to run command against
|
97 | -r, --remote=remote git remote of app to use
|
98 | -s, --shell output config vars in shell format
|
99 |
|
100 | EXAMPLES
|
101 | $ heroku config:get RAILS_ENV
|
102 | production
|
103 | ```
|
104 |
|
105 | _See code: [src/commands/config/get.ts](https://github.com/heroku/cli/blob/v7.5.6/packages/config/src/commands/config/get.ts)_
|
106 |
|
107 | ## `heroku config:unset`
|
108 |
|
109 | unset one or more config vars
|
110 |
|
111 | ```
|
112 | USAGE
|
113 | $ heroku config:unset
|
114 |
|
115 | OPTIONS
|
116 | -a, --app=app (required) app to run command against
|
117 | -r, --remote=remote git remote of app to use
|
118 |
|
119 | ALIASES
|
120 | $ heroku config:remove
|
121 |
|
122 | EXAMPLES
|
123 | $ heroku config:unset RAILS_ENV
|
124 | Unsetting RAILS_ENV and restarting example... done, v10
|
125 | $ heroku config:unset RAILS_ENV RACK_ENV
|
126 | Unsetting RAILS_ENV, RACK_ENV and restarting example... done, v10
|
127 | ```
|
128 |
|
129 | _See code: [src/commands/config/unset.ts](https://github.com/heroku/cli/blob/v7.5.6/packages/config/src/commands/config/unset.ts)_
|
130 |
|