]>
Commit | Line | Data |
---|---|---|
e0d10e1c TP |
1 | git-config(1) |
2 | ============= | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | git-config - Get and set repository or global options | |
7 | ||
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
11 | [verse] | |
70bd879a | 12 | 'git config' [<file-option>] [type] [--show-origin] [-z|--null] name [value [value_regex]] |
b1889c36 | 13 | 'git config' [<file-option>] [type] --add name value |
bf71b4b3 | 14 | 'git config' [<file-option>] [type] --replace-all name value [value_regex] |
70bd879a LS |
15 | 'git config' [<file-option>] [type] [--show-origin] [-z|--null] --get name [value_regex] |
16 | 'git config' [<file-option>] [type] [--show-origin] [-z|--null] --get-all name [value_regex] | |
17 | 'git config' [<file-option>] [type] [--show-origin] [-z|--null] [--name-only] --get-regexp name_regex [value_regex] | |
d4770964 | 18 | 'git config' [<file-option>] [type] [-z|--null] --get-urlmatch name URL |
b1889c36 JN |
19 | 'git config' [<file-option>] --unset name [value_regex] |
20 | 'git config' [<file-option>] --unset-all name [value_regex] | |
21 | 'git config' [<file-option>] --rename-section old_name new_name | |
22 | 'git config' [<file-option>] --remove-section name | |
70bd879a | 23 | 'git config' [<file-option>] [--show-origin] [-z|--null] [--name-only] -l | --list |
b1889c36 JN |
24 | 'git config' [<file-option>] --get-color name [default] |
25 | 'git config' [<file-option>] --get-colorbool name [stdout-is-tty] | |
3bec8ff9 | 26 | 'git config' [<file-option>] -e | --edit |
e0d10e1c TP |
27 | |
28 | DESCRIPTION | |
29 | ----------- | |
30 | You can query/set/replace/unset options with this command. The name is | |
31 | actually the section and the key separated by a dot, and the value will be | |
32 | escaped. | |
33 | ||
bcf9626a | 34 | Multiple lines can be added to an option by using the `--add` option. |
e0d10e1c TP |
35 | If you want to update or unset an option which can occur on multiple |
36 | lines, a POSIX regexp `value_regex` needs to be given. Only the | |
37 | existing values that match the regexp are updated or unset. If | |
38 | you want to handle the lines that do *not* match the regex, just | |
90a36e58 | 39 | prepend a single exclamation mark in front (see also <<EXAMPLES>>). |
e0d10e1c | 40 | |
bcf9626a | 41 | The type specifier can be either `--int` or `--bool`, to make |
0b444cdb | 42 | 'git config' ensure that the variable(s) are of the given type and |
e0d10e1c | 43 | convert the value to the canonical form (simple decimal number for int, |
bcf9626a MM |
44 | a "true" or "false" string for bool), or `--path`, which does some |
45 | path expansion (see `--path` below). If no type specifier is passed, no | |
1349484e | 46 | checks or transformations are performed on the value. |
e0d10e1c | 47 | |
c598c5aa FA |
48 | When reading, the values are read from the system, global and |
49 | repository local configuration files by default, and options | |
bb72e10a | 50 | `--system`, `--global`, `--local` and `--file <filename>` can be |
c598c5aa FA |
51 | used to tell the command to read from only that location (see <<FILES>>). |
52 | ||
53 | When writing, the new value is written to the repository local | |
bcf9626a | 54 | configuration file by default, and options `--system`, `--global`, |
bb72e10a | 55 | `--file <filename>` can be used to tell the command to write to |
bcf9626a | 56 | that location (you can say `--local` but that is the default). |
be52a41c | 57 | |
9409c7a5 JH |
58 | This command will fail with non-zero status upon error. Some exit |
59 | codes are: | |
e0d10e1c | 60 | |
376eb604 | 61 | - The section or key is invalid (ret=1), |
94c5b0e8 | 62 | - no section or name was provided (ret=2), |
376eb604 SB |
63 | - the config file is invalid (ret=3), |
64 | - the config file cannot be written (ret=4), | |
94c5b0e8 JK |
65 | - you try to unset an option which does not exist (ret=5), |
66 | - you try to unset/set an option for which multiple lines match (ret=5), or | |
67 | - you try to use an invalid regexp (ret=6). | |
e0d10e1c | 68 | |
7a397419 | 69 | On success, the command returns the exit code 0. |
e0d10e1c TP |
70 | |
71 | OPTIONS | |
72 | ------- | |
73 | ||
74 | --replace-all:: | |
75 | Default behavior is to replace at most one line. This replaces | |
76 | all lines matching the key (and optionally the value_regex). | |
77 | ||
78 | --add:: | |
79 | Adds a new line to the option without altering any existing | |
ac9f71cf FC |
80 | values. This is the same as providing '^$' as the value_regex |
81 | in `--replace-all`. | |
e0d10e1c TP |
82 | |
83 | --get:: | |
84 | Get the value for a given key (optionally filtered by a regex | |
85 | matching the value). Returns error code 1 if the key was not | |
62e91efa | 86 | found and the last value if multiple key values were found. |
e0d10e1c TP |
87 | |
88 | --get-all:: | |
24990b2f | 89 | Like get, but returns all values for a multi-valued key. |
e0d10e1c TP |
90 | |
91 | --get-regexp:: | |
e0a4aae8 LP |
92 | Like --get-all, but interprets the name as a regular expression and |
93 | writes out the key names. Regular expression matching is currently | |
94 | case-sensitive and done against a canonicalized version of the key | |
95 | in which section and variable names are lowercased, but subsection | |
96 | names are not. | |
e0d10e1c | 97 | |
d4770964 JH |
98 | --get-urlmatch name URL:: |
99 | When given a two-part name section.key, the value for | |
100 | section.<url>.key whose <url> part matches the best to the | |
101 | given URL is returned (if no such key exists, the value for | |
102 | section.key is used as a fallback). When given just the | |
103 | section as name, do so for all the keys in the section and | |
27b30be6 | 104 | list them. Returns error code 1 if no value is found. |
d4770964 | 105 | |
e0d10e1c | 106 | --global:: |
5ff0c0e8 RR |
107 | For writing options: write to global `~/.gitconfig` file |
108 | rather than the repository `.git/config`, write to | |
109 | `$XDG_CONFIG_HOME/git/config` file if this file exists and the | |
110 | `~/.gitconfig` file doesn't. | |
17014090 | 111 | + |
5ff0c0e8 RR |
112 | For reading options: read only from global `~/.gitconfig` and from |
113 | `$XDG_CONFIG_HOME/git/config` rather than from all available files. | |
17014090 FL |
114 | + |
115 | See also <<FILES>>. | |
e0d10e1c | 116 | |
9bc20aa7 | 117 | --system:: |
5ff0c0e8 RR |
118 | For writing options: write to system-wide |
119 | `$(prefix)/etc/gitconfig` rather than the repository | |
120 | `.git/config`. | |
17014090 | 121 | + |
5ff0c0e8 | 122 | For reading options: read only from system-wide `$(prefix)/etc/gitconfig` |
17014090 FL |
123 | rather than from all available files. |
124 | + | |
125 | See also <<FILES>>. | |
9bc20aa7 | 126 | |
560d4b86 | 127 | --local:: |
5ff0c0e8 | 128 | For writing options: write to the repository `.git/config` file. |
560d4b86 NK |
129 | This is the default behavior. |
130 | + | |
5ff0c0e8 | 131 | For reading options: read only from the repository `.git/config` rather than |
560d4b86 NK |
132 | from all available files. |
133 | + | |
134 | See also <<FILES>>. | |
135 | ||
3240240f SB |
136 | -f config-file:: |
137 | --file config-file:: | |
67d454fe AR |
138 | Use the given config file instead of the one specified by GIT_CONFIG. |
139 | ||
1bc88819 | 140 | --blob blob:: |
bcf9626a | 141 | Similar to `--file` but use the given blob instead of a file. E.g. |
1bc88819 HV |
142 | you can use 'master:.gitmodules' to read values from the file |
143 | '.gitmodules' in the master branch. See "SPECIFYING REVISIONS" | |
144 | section in linkgit:gitrevisions[7] for a more complete list of | |
145 | ways to spell blob names. | |
146 | ||
118f8b24 PB |
147 | --remove-section:: |
148 | Remove the given section from the configuration file. | |
149 | ||
150 | --rename-section:: | |
151 | Rename the given section to a new name. | |
152 | ||
e0d10e1c TP |
153 | --unset:: |
154 | Remove the line matching the key from config file. | |
155 | ||
156 | --unset-all:: | |
9debca9a | 157 | Remove all lines matching the key from config file. |
e0d10e1c | 158 | |
3240240f SB |
159 | -l:: |
160 | --list:: | |
578625fa | 161 | List all variables set in config file, along with their values. |
e0d10e1c TP |
162 | |
163 | --bool:: | |
0b444cdb | 164 | 'git config' will ensure that the output is "true" or "false" |
e0d10e1c TP |
165 | |
166 | --int:: | |
0b444cdb | 167 | 'git config' will ensure that the output is a simple |
e0d10e1c TP |
168 | decimal number. An optional value suffix of 'k', 'm', or 'g' |
169 | in the config file will cause the value to be multiplied | |
170 | by 1024, 1048576, or 1073741824 prior to output. | |
171 | ||
d57f07eb | 172 | --bool-or-int:: |
0b444cdb | 173 | 'git config' will ensure that the output matches the format of |
d57f07eb JK |
174 | either --bool or --int, as described above. |
175 | ||
1349484e | 176 | --path:: |
32fceba3 NP |
177 | `git config` will expand a leading `~` to the value of |
178 | `$HOME`, and `~user` to the home directory for the | |
1349484e | 179 | specified user. This option has no effect when setting the |
32fceba3 NP |
180 | value (but you can use `git config section.variable ~/` |
181 | from the command line to let your shell do the expansion). | |
1349484e | 182 | |
5f967424 HM |
183 | --expiry-date:: |
184 | `git config` will ensure that the output is converted from | |
185 | a fixed or relative date-string to a timestamp. This option | |
186 | has no effect when setting the value. | |
187 | ||
3240240f SB |
188 | -z:: |
189 | --null:: | |
2275d502 | 190 | For all options that output values and/or keys, always |
a5d86f74 | 191 | end values with the null character (instead of a |
2275d502 FL |
192 | newline). Use newline instead as a delimiter between |
193 | key and value. This allows for secure parsing of the | |
194 | output without getting confused e.g. by values that | |
195 | contain line breaks. | |
196 | ||
578625fa SG |
197 | --name-only:: |
198 | Output only the names of config variables for `--list` or | |
199 | `--get-regexp`. | |
200 | ||
70bd879a LS |
201 | --show-origin:: |
202 | Augment the output of all queried config options with the | |
203 | origin type (file, standard input, blob, command line) and | |
204 | the actual origin (config file path, ref, or blob id if | |
205 | applicable). | |
206 | ||
0f6f5a40 JH |
207 | --get-colorbool name [stdout-is-tty]:: |
208 | ||
209 | Find the color setting for `name` (e.g. `color.diff`) and output | |
210 | "true" or "false". `stdout-is-tty` should be either "true" or | |
211 | "false", and is taken into account when configuration says | |
212 | "auto". If `stdout-is-tty` is missing, then checks the standard | |
213 | output of the command itself, and exits with status 0 if color | |
214 | is to be used, or exits with status 1 otherwise. | |
4d4f5ba3 MK |
215 | When the color setting for `name` is undefined, the command uses |
216 | `color.ui` as fallback. | |
0f6f5a40 | 217 | |
ac9f71cf | 218 | --get-color name [default]:: |
9ce03522 JH |
219 | |
220 | Find the color configured for `name` (e.g. `color.diff.new`) and | |
221 | output it as the ANSI color escape sequence to the standard | |
222 | output. The optional `default` parameter is used instead, if | |
223 | there is no color configured for `name`. | |
e0d10e1c | 224 | |
3bec8ff9 FC |
225 | -e:: |
226 | --edit:: | |
227 | Opens an editor to modify the specified config file; either | |
bcf9626a | 228 | `--system`, `--global`, or repository (default). |
3bec8ff9 | 229 | |
0460ed2c | 230 | --[no-]includes:: |
9b25a0b5 | 231 | Respect `include.*` directives in config files when looking up |
753a2cda JK |
232 | values. Defaults to `off` when a specific file is given (e.g., |
233 | using `--file`, `--global`, etc) and `on` when searching all | |
234 | config files. | |
9b25a0b5 | 235 | |
17014090 FL |
236 | [[FILES]] |
237 | FILES | |
238 | ----- | |
239 | ||
bcf9626a | 240 | If not set explicitly with `--file`, there are four files where |
0b444cdb | 241 | 'git config' will search for configuration options: |
17014090 | 242 | |
7da9800f JK |
243 | $(prefix)/etc/gitconfig:: |
244 | System-wide configuration file. | |
17014090 | 245 | |
21cf3227 HKNN |
246 | $XDG_CONFIG_HOME/git/config:: |
247 | Second user-specific configuration file. If $XDG_CONFIG_HOME is not set | |
5ff0c0e8 | 248 | or empty, `$HOME/.config/git/config` will be used. Any single-valued |
21cf3227 | 249 | variable set in this file will be overwritten by whatever is in |
5ff0c0e8 | 250 | `~/.gitconfig`. It is a good idea not to create this file if |
21cf3227 HKNN |
251 | you sometimes use older versions of Git, as support for this |
252 | file was added fairly recently. | |
253 | ||
7da9800f JK |
254 | ~/.gitconfig:: |
255 | User-specific configuration file. Also called "global" | |
256 | configuration file. | |
257 | ||
258 | $GIT_DIR/config:: | |
259 | Repository specific configuration file. | |
17014090 FL |
260 | |
261 | If no further options are given, all reading options will read all of these | |
262 | files that are available. If the global or the system-wide configuration | |
263 | file are not available they will be ignored. If the repository configuration | |
0b444cdb | 264 | file is not available or readable, 'git config' will exit with a non-zero |
17014090 FL |
265 | error code. However, in neither case will an error message be issued. |
266 | ||
7da9800f JK |
267 | The files are read in the order given above, with last value found taking |
268 | precedence over values read earlier. When multiple values are taken then all | |
269 | values of a key from all files will be used. | |
270 | ||
ae1f7094 DG |
271 | You may override individual configuration parameters when running any git |
272 | command by using the `-c` option. See linkgit:git[1] for details. | |
273 | ||
17014090 | 274 | All writing options will per default write to the repository specific |
bcf9626a MM |
275 | configuration file. Note that this also affects options like `--replace-all` |
276 | and `--unset`. *'git config' will only ever change one file at a time*. | |
17014090 | 277 | |
06ab60c0 | 278 | You can override these rules either by command-line options or by environment |
bcf9626a | 279 | variables. The `--global` and the `--system` options will limit the file used |
47d81b5c | 280 | to the global or system-wide file respectively. The `GIT_CONFIG` environment |
17014090 FL |
281 | variable has a similar effect, but you can specify any filename you want. |
282 | ||
17014090 | 283 | |
e0d10e1c TP |
284 | ENVIRONMENT |
285 | ----------- | |
286 | ||
287 | GIT_CONFIG:: | |
288 | Take the configuration from the given file instead of .git/config. | |
17014090 FL |
289 | Using the "--global" option forces this to ~/.gitconfig. Using the |
290 | "--system" option forces this to $(prefix)/etc/gitconfig. | |
e0d10e1c | 291 | |
e8ef401c JN |
292 | GIT_CONFIG_NOSYSTEM:: |
293 | Whether to skip reading settings from the system-wide | |
294 | $(prefix)/etc/gitconfig file. See linkgit:git[1] for details. | |
295 | ||
17014090 | 296 | See also <<FILES>>. |
e0d10e1c | 297 | |
90a36e58 FL |
298 | |
299 | [[EXAMPLES]] | |
300 | EXAMPLES | |
301 | -------- | |
e0d10e1c TP |
302 | |
303 | Given a .git/config like this: | |
304 | ||
305 | # | |
306 | # This is the config file, and | |
307 | # a '#' or ';' character indicates | |
308 | # a comment | |
309 | # | |
310 | ||
311 | ; core variables | |
312 | [core] | |
313 | ; Don't trust file modes | |
314 | filemode = false | |
315 | ||
316 | ; Our diff algorithm | |
317 | [diff] | |
6bb9e51b | 318 | external = /usr/local/bin/diff-wrapper |
e0d10e1c TP |
319 | renames = true |
320 | ||
321 | ; Proxy settings | |
322 | [core] | |
d1e1fe75 | 323 | gitproxy=proxy-command for kernel.org |
e0d10e1c TP |
324 | gitproxy=default-proxy ; for all the rest |
325 | ||
d4770964 JH |
326 | ; HTTP |
327 | [http] | |
328 | sslVerify | |
329 | [http "https://weak.example.com"] | |
330 | sslVerify = false | |
331 | cookieFile = /tmp/cookie.txt | |
332 | ||
e0d10e1c TP |
333 | you can set the filemode to true with |
334 | ||
335 | ------------ | |
336 | % git config core.filemode true | |
337 | ------------ | |
338 | ||
339 | The hypothetical proxy command entries actually have a postfix to discern | |
340 | what URL they apply to. Here is how to change the entry for kernel.org | |
341 | to "ssh". | |
342 | ||
343 | ------------ | |
344 | % git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$' | |
345 | ------------ | |
346 | ||
347 | This makes sure that only the key/value pair for kernel.org is replaced. | |
348 | ||
349 | To delete the entry for renames, do | |
350 | ||
351 | ------------ | |
352 | % git config --unset diff.renames | |
353 | ------------ | |
354 | ||
355 | If you want to delete an entry for a multivar (like core.gitproxy above), | |
356 | you have to provide a regex matching the value of exactly one line. | |
357 | ||
358 | To query the value for a given key, do | |
359 | ||
360 | ------------ | |
361 | % git config --get core.filemode | |
362 | ------------ | |
363 | ||
364 | or | |
365 | ||
366 | ------------ | |
367 | % git config core.filemode | |
368 | ------------ | |
369 | ||
370 | or, to query a multivar: | |
371 | ||
372 | ------------ | |
373 | % git config --get core.gitproxy "for kernel.org$" | |
374 | ------------ | |
375 | ||
376 | If you want to know all the values for a multivar, do: | |
377 | ||
378 | ------------ | |
379 | % git config --get-all core.gitproxy | |
380 | ------------ | |
381 | ||
544ddb04 | 382 | If you like to live dangerously, you can replace *all* core.gitproxy by a |
e0d10e1c TP |
383 | new one with |
384 | ||
385 | ------------ | |
386 | % git config --replace-all core.gitproxy ssh | |
387 | ------------ | |
388 | ||
389 | However, if you really only want to replace the line for the default proxy, | |
390 | i.e. the one without a "for ..." postfix, do something like this: | |
391 | ||
392 | ------------ | |
393 | % git config core.gitproxy ssh '! for ' | |
394 | ------------ | |
395 | ||
396 | To actually match only values with an exclamation mark, you have to | |
397 | ||
398 | ------------ | |
399 | % git config section.key value '[!]' | |
400 | ------------ | |
401 | ||
402 | To add a new proxy, without altering any of the existing ones, use | |
403 | ||
404 | ------------ | |
d0714cc8 | 405 | % git config --add core.gitproxy '"proxy-command" for example.com' |
e0d10e1c TP |
406 | ------------ |
407 | ||
9ce03522 JH |
408 | An example to use customized color from the configuration in your |
409 | script: | |
410 | ||
411 | ------------ | |
412 | #!/bin/sh | |
413 | WS=$(git config --get-color color.diff.whitespace "blue reverse") | |
414 | RESET=$(git config --get-color "" "reset") | |
415 | echo "${WS}your whitespace color or blue reverse${RESET}" | |
416 | ------------ | |
e0d10e1c | 417 | |
d4770964 JH |
418 | For URLs in `https://weak.example.com`, `http.sslVerify` is set to |
419 | false, while it is set to `true` for all others: | |
420 | ||
421 | ------------ | |
422 | % git config --bool --get-urlmatch http.sslverify https://good.example.com | |
423 | true | |
424 | % git config --bool --get-urlmatch http.sslverify https://weak.example.com | |
425 | false | |
426 | % git config --get-urlmatch http https://weak.example.com | |
da0005b8 | 427 | http.cookieFile /tmp/cookie.txt |
d4770964 JH |
428 | http.sslverify false |
429 | ------------ | |
430 | ||
e0d10e1c TP |
431 | include::config.txt[] |
432 | ||
e0d10e1c TP |
433 | GIT |
434 | --- | |
9e1f0a85 | 435 | Part of the linkgit:git[1] suite |