Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 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] |
Taylor Blau | fb0dc3b | 2018-04-18 14:43:35 -0700 | [diff] [blame] | 12 | 'git config' [<file-option>] [--type=<type>] [--show-origin] [-z|--null] name [value [value_regex]] |
| 13 | 'git config' [<file-option>] [--type=<type>] --add name value |
| 14 | 'git config' [<file-option>] [--type=<type>] --replace-all name value [value_regex] |
| 15 | 'git config' [<file-option>] [--type=<type>] [--show-origin] [-z|--null] --get name [value_regex] |
| 16 | 'git config' [<file-option>] [--type=<type>] [--show-origin] [-z|--null] --get-all name [value_regex] |
| 17 | 'git config' [<file-option>] [--type=<type>] [--show-origin] [-z|--null] [--name-only] --get-regexp name_regex [value_regex] |
| 18 | 'git config' [<file-option>] [--type=<type>] [-z|--null] --get-urlmatch name URL |
Jonathan Nieder | b1889c3 | 2008-06-30 01:09:04 -0500 | [diff] [blame] | 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 |
Lars Schneider | 70bd879 | 2016-02-19 10:16:02 +0100 | [diff] [blame] | 23 | 'git config' [<file-option>] [--show-origin] [-z|--null] [--name-only] -l | --list |
Jonathan Nieder | b1889c3 | 2008-06-30 01:09:04 -0500 | [diff] [blame] | 24 | 'git config' [<file-option>] --get-color name [default] |
| 25 | 'git config' [<file-option>] --get-colorbool name [stdout-is-tty] |
Felipe Contreras | 3bec8ff | 2009-02-07 23:53:00 +0200 | [diff] [blame] | 26 | 'git config' [<file-option>] -e | --edit |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 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 | |
Matthieu Moy | bcf9626 | 2016-06-28 13:40:11 +0200 | [diff] [blame] | 34 | Multiple lines can be added to an option by using the `--add` option. |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 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 |
Frank Lichtenheld | 90a36e5 | 2007-05-31 02:35:36 +0200 | [diff] [blame] | 39 | prepend a single exclamation mark in front (see also <<EXAMPLES>>). |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 40 | |
Taylor Blau | fb0dc3b | 2018-04-18 14:43:35 -0700 | [diff] [blame] | 41 | The `--type=<type>` option instructs 'git config' to ensure that incoming and |
| 42 | outgoing values are canonicalize-able under the given <type>. If no |
| 43 | `--type=<type>` is given, no canonicalization will be performed. Callers may |
| 44 | unset an existing `--type` specifier with `--no-type`. |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 45 | |
Florian Achleitner | c598c5a | 2012-05-05 12:03:52 +0200 | [diff] [blame] | 46 | When reading, the values are read from the system, global and |
| 47 | repository local configuration files by default, and options |
Nguyễn Thái Ngọc Duy | 58b284a | 2018-10-21 16:02:28 +0200 | [diff] [blame] | 48 | `--system`, `--global`, `--local`, `--worktree` and |
| 49 | `--file <filename>` can be used to tell the command to read from only |
| 50 | that location (see <<FILES>>). |
Florian Achleitner | c598c5a | 2012-05-05 12:03:52 +0200 | [diff] [blame] | 51 | |
| 52 | When writing, the new value is written to the repository local |
Matthieu Moy | bcf9626 | 2016-06-28 13:40:11 +0200 | [diff] [blame] | 53 | configuration file by default, and options `--system`, `--global`, |
Nguyễn Thái Ngọc Duy | 58b284a | 2018-10-21 16:02:28 +0200 | [diff] [blame] | 54 | `--worktree`, `--file <filename>` can be used to tell the command to |
| 55 | write to that location (you can say `--local` but that is the |
| 56 | default). |
Alex Riesen | be52a41 | 2007-08-01 00:01:17 +0200 | [diff] [blame] | 57 | |
Junio C Hamano | 9409c7a | 2012-07-29 13:43:21 -0700 | [diff] [blame] | 58 | This command will fail with non-zero status upon error. Some exit |
| 59 | codes are: |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 60 | |
Stefan Beller | 376eb60 | 2016-04-26 11:10:58 -0700 | [diff] [blame] | 61 | - The section or key is invalid (ret=1), |
John Keeping | 94c5b0e | 2016-02-28 11:54:36 +0000 | [diff] [blame] | 62 | - no section or name was provided (ret=2), |
Stefan Beller | 376eb60 | 2016-04-26 11:10:58 -0700 | [diff] [blame] | 63 | - the config file is invalid (ret=3), |
| 64 | - the config file cannot be written (ret=4), |
John Keeping | 94c5b0e | 2016-02-28 11:54:36 +0000 | [diff] [blame] | 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). |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 68 | |
Michael J Gruber | 7a39741 | 2011-05-17 17:38:52 +0200 | [diff] [blame] | 69 | On success, the command returns the exit code 0. |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 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 |
Felipe Contreras | ac9f71c | 2009-05-07 01:57:08 +0300 | [diff] [blame] | 80 | values. This is the same as providing '^$' as the value_regex |
| 81 | in `--replace-all`. |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 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 |
John Keeping | 62e91ef | 2013-07-03 19:27:39 +0100 | [diff] [blame] | 86 | found and the last value if multiple key values were found. |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 87 | |
| 88 | --get-all:: |
John Keeping | 24990b2 | 2016-02-28 11:54:37 +0000 | [diff] [blame] | 89 | Like get, but returns all values for a multi-valued key. |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 90 | |
| 91 | --get-regexp:: |
Libor Pechacek | e0a4aae | 2012-03-01 11:59:45 +0100 | [diff] [blame] | 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. |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 97 | |
Junio C Hamano | d477096 | 2013-07-31 11:14:59 -0700 | [diff] [blame] | 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 |
John Keeping | 27b30be | 2016-02-28 11:54:35 +0000 | [diff] [blame] | 104 | list them. Returns error code 1 if no value is found. |
Junio C Hamano | d477096 | 2013-07-31 11:14:59 -0700 | [diff] [blame] | 105 | |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 106 | --global:: |
Ramkumar Ramachandra | 5ff0c0e | 2013-07-26 16:12:02 +0530 | [diff] [blame] | 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. |
Frank Lichtenheld | 1701409 | 2007-05-31 02:35:37 +0200 | [diff] [blame] | 111 | + |
Ramkumar Ramachandra | 5ff0c0e | 2013-07-26 16:12:02 +0530 | [diff] [blame] | 112 | For reading options: read only from global `~/.gitconfig` and from |
| 113 | `$XDG_CONFIG_HOME/git/config` rather than from all available files. |
Frank Lichtenheld | 1701409 | 2007-05-31 02:35:37 +0200 | [diff] [blame] | 114 | + |
| 115 | See also <<FILES>>. |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 116 | |
Andrew Ruder | 9bc20aa | 2007-04-18 22:03:37 -0500 | [diff] [blame] | 117 | --system:: |
Ramkumar Ramachandra | 5ff0c0e | 2013-07-26 16:12:02 +0530 | [diff] [blame] | 118 | For writing options: write to system-wide |
| 119 | `$(prefix)/etc/gitconfig` rather than the repository |
| 120 | `.git/config`. |
Frank Lichtenheld | 1701409 | 2007-05-31 02:35:37 +0200 | [diff] [blame] | 121 | + |
Ramkumar Ramachandra | 5ff0c0e | 2013-07-26 16:12:02 +0530 | [diff] [blame] | 122 | For reading options: read only from system-wide `$(prefix)/etc/gitconfig` |
Frank Lichtenheld | 1701409 | 2007-05-31 02:35:37 +0200 | [diff] [blame] | 123 | rather than from all available files. |
| 124 | + |
| 125 | See also <<FILES>>. |
Andrew Ruder | 9bc20aa | 2007-04-18 22:03:37 -0500 | [diff] [blame] | 126 | |
Namhyung Kim | 560d4b8 | 2013-06-17 22:31:31 +0900 | [diff] [blame] | 127 | --local:: |
Ramkumar Ramachandra | 5ff0c0e | 2013-07-26 16:12:02 +0530 | [diff] [blame] | 128 | For writing options: write to the repository `.git/config` file. |
Namhyung Kim | 560d4b8 | 2013-06-17 22:31:31 +0900 | [diff] [blame] | 129 | This is the default behavior. |
| 130 | + |
Ramkumar Ramachandra | 5ff0c0e | 2013-07-26 16:12:02 +0530 | [diff] [blame] | 131 | For reading options: read only from the repository `.git/config` rather than |
Namhyung Kim | 560d4b8 | 2013-06-17 22:31:31 +0900 | [diff] [blame] | 132 | from all available files. |
| 133 | + |
| 134 | See also <<FILES>>. |
| 135 | |
Nguyễn Thái Ngọc Duy | 58b284a | 2018-10-21 16:02:28 +0200 | [diff] [blame] | 136 | --worktree:: |
| 137 | Similar to `--local` except that `.git/config.worktree` is |
| 138 | read from or written to if `extensions.worktreeConfig` is |
| 139 | present. If not it's the same as `--local`. |
| 140 | |
Stephan Beyer | 3240240 | 2008-06-08 03:36:09 +0200 | [diff] [blame] | 141 | -f config-file:: |
| 142 | --file config-file:: |
Alex Riesen | 67d454f | 2007-07-31 11:58:43 +0200 | [diff] [blame] | 143 | Use the given config file instead of the one specified by GIT_CONFIG. |
| 144 | |
Heiko Voigt | 1bc8881 | 2013-07-12 00:46:47 +0200 | [diff] [blame] | 145 | --blob blob:: |
Matthieu Moy | bcf9626 | 2016-06-28 13:40:11 +0200 | [diff] [blame] | 146 | Similar to `--file` but use the given blob instead of a file. E.g. |
Heiko Voigt | 1bc8881 | 2013-07-12 00:46:47 +0200 | [diff] [blame] | 147 | you can use 'master:.gitmodules' to read values from the file |
| 148 | '.gitmodules' in the master branch. See "SPECIFYING REVISIONS" |
| 149 | section in linkgit:gitrevisions[7] for a more complete list of |
| 150 | ways to spell blob names. |
| 151 | |
Paolo Bonzini | 118f8b2 | 2007-03-02 21:53:33 +0100 | [diff] [blame] | 152 | --remove-section:: |
| 153 | Remove the given section from the configuration file. |
| 154 | |
| 155 | --rename-section:: |
| 156 | Rename the given section to a new name. |
| 157 | |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 158 | --unset:: |
| 159 | Remove the line matching the key from config file. |
| 160 | |
| 161 | --unset-all:: |
Yann Dirson | 9debca9 | 2007-03-14 22:08:41 +0100 | [diff] [blame] | 162 | Remove all lines matching the key from config file. |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 163 | |
Stephan Beyer | 3240240 | 2008-06-08 03:36:09 +0200 | [diff] [blame] | 164 | -l:: |
| 165 | --list:: |
SZEDER Gábor | 578625f | 2015-08-10 11:46:06 +0200 | [diff] [blame] | 166 | List all variables set in config file, along with their values. |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 167 | |
Taylor Blau | fb0dc3b | 2018-04-18 14:43:35 -0700 | [diff] [blame] | 168 | --type <type>:: |
| 169 | 'git config' will ensure that any input or output is valid under the given |
| 170 | type constraint(s), and will canonicalize outgoing values in `<type>`'s |
| 171 | canonical form. |
| 172 | + |
| 173 | Valid `<type>`'s include: |
| 174 | + |
| 175 | - 'bool': canonicalize values as either "true" or "false". |
| 176 | - 'int': canonicalize values as simple decimal numbers. An optional suffix of |
| 177 | 'k', 'm', or 'g' will cause the value to be multiplied by 1024, 1048576, or |
| 178 | 1073741824 upon input. |
| 179 | - 'bool-or-int': canonicalize according to either 'bool' or 'int', as described |
| 180 | above. |
| 181 | - 'path': canonicalize by adding a leading `~` to the value of `$HOME` and |
| 182 | `~user` to the home directory for the specified user. This specifier has no |
| 183 | effect when setting the value (but you can use `git config section.variable |
| 184 | ~/` from the command line to let your shell do the expansion.) |
| 185 | - 'expiry-date': canonicalize by converting from a fixed or relative date-string |
| 186 | to a timestamp. This specifier has no effect when setting the value. |
Taylor Blau | 63e2a0f | 2018-04-09 17:18:31 -0700 | [diff] [blame] | 187 | - 'color': When getting a value, canonicalize by converting to an ANSI color |
| 188 | escape sequence. When setting a value, a sanity-check is performed to ensure |
| 189 | that the given value is canonicalize-able as an ANSI color, but it is written |
| 190 | as-is. |
Taylor Blau | fb0dc3b | 2018-04-18 14:43:35 -0700 | [diff] [blame] | 191 | + |
| 192 | |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 193 | --bool:: |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 194 | --int:: |
Jeff King | d57f07e | 2009-03-07 12:14:06 -0500 | [diff] [blame] | 195 | --bool-or-int:: |
Matthieu Moy | 1349484 | 2009-12-30 17:51:53 +0100 | [diff] [blame] | 196 | --path:: |
Haaris Mehmood | 5f96742 | 2017-11-18 02:27:27 +0000 | [diff] [blame] | 197 | --expiry-date:: |
Martin Ågren | 08caa95 | 2018-09-19 18:38:19 +0200 | [diff] [blame] | 198 | Historical options for selecting a type specifier. Prefer instead `--type` |
| 199 | (see above). |
Taylor Blau | fb0dc3b | 2018-04-18 14:43:35 -0700 | [diff] [blame] | 200 | |
| 201 | --no-type:: |
| 202 | Un-sets the previously set type specifier (if one was previously set). This |
| 203 | option requests that 'git config' not canonicalize the retrieved variable. |
| 204 | `--no-type` has no effect without `--type=<type>` or `--<type>`. |
Haaris Mehmood | 5f96742 | 2017-11-18 02:27:27 +0000 | [diff] [blame] | 205 | |
Stephan Beyer | 3240240 | 2008-06-08 03:36:09 +0200 | [diff] [blame] | 206 | -z:: |
| 207 | --null:: |
Frank Lichtenheld | 2275d50 | 2007-06-25 16:03:55 +0200 | [diff] [blame] | 208 | For all options that output values and/or keys, always |
Jim Meyering | a5d86f7 | 2008-01-29 20:38:55 +0100 | [diff] [blame] | 209 | end values with the null character (instead of a |
Frank Lichtenheld | 2275d50 | 2007-06-25 16:03:55 +0200 | [diff] [blame] | 210 | newline). Use newline instead as a delimiter between |
| 211 | key and value. This allows for secure parsing of the |
| 212 | output without getting confused e.g. by values that |
| 213 | contain line breaks. |
| 214 | |
SZEDER Gábor | 578625f | 2015-08-10 11:46:06 +0200 | [diff] [blame] | 215 | --name-only:: |
| 216 | Output only the names of config variables for `--list` or |
| 217 | `--get-regexp`. |
| 218 | |
Lars Schneider | 70bd879 | 2016-02-19 10:16:02 +0100 | [diff] [blame] | 219 | --show-origin:: |
| 220 | Augment the output of all queried config options with the |
| 221 | origin type (file, standard input, blob, command line) and |
| 222 | the actual origin (config file path, ref, or blob id if |
| 223 | applicable). |
| 224 | |
Junio C Hamano | 0f6f5a4 | 2007-12-05 17:26:11 -0800 | [diff] [blame] | 225 | --get-colorbool name [stdout-is-tty]:: |
| 226 | |
| 227 | Find the color setting for `name` (e.g. `color.diff`) and output |
| 228 | "true" or "false". `stdout-is-tty` should be either "true" or |
| 229 | "false", and is taken into account when configuration says |
| 230 | "auto". If `stdout-is-tty` is missing, then checks the standard |
| 231 | output of the command itself, and exits with status 0 if color |
| 232 | is to be used, or exits with status 1 otherwise. |
Matthias Kestenholz | 4d4f5ba | 2008-04-09 21:32:06 +0200 | [diff] [blame] | 233 | When the color setting for `name` is undefined, the command uses |
| 234 | `color.ui` as fallback. |
Junio C Hamano | 0f6f5a4 | 2007-12-05 17:26:11 -0800 | [diff] [blame] | 235 | |
Felipe Contreras | ac9f71c | 2009-05-07 01:57:08 +0300 | [diff] [blame] | 236 | --get-color name [default]:: |
Junio C Hamano | 9ce0352 | 2007-11-27 22:41:05 -0800 | [diff] [blame] | 237 | |
| 238 | Find the color configured for `name` (e.g. `color.diff.new`) and |
| 239 | output it as the ANSI color escape sequence to the standard |
| 240 | output. The optional `default` parameter is used instead, if |
| 241 | there is no color configured for `name`. |
Taylor Blau | 63e2a0f | 2018-04-09 17:18:31 -0700 | [diff] [blame] | 242 | + |
| 243 | `--type=color [--default=<default>]` is preferred over `--get-color`. |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 244 | |
Felipe Contreras | 3bec8ff | 2009-02-07 23:53:00 +0200 | [diff] [blame] | 245 | -e:: |
| 246 | --edit:: |
| 247 | Opens an editor to modify the specified config file; either |
Matthieu Moy | bcf9626 | 2016-06-28 13:40:11 +0200 | [diff] [blame] | 248 | `--system`, `--global`, or repository (default). |
Felipe Contreras | 3bec8ff | 2009-02-07 23:53:00 +0200 | [diff] [blame] | 249 | |
Felipe Contreras | 0460ed2 | 2013-05-08 20:16:55 -0500 | [diff] [blame] | 250 | --[no-]includes:: |
Jeff King | 9b25a0b | 2012-02-06 04:54:04 -0500 | [diff] [blame] | 251 | Respect `include.*` directives in config files when looking up |
Jeff King | 753a2cd | 2015-01-19 14:58:47 -0500 | [diff] [blame] | 252 | values. Defaults to `off` when a specific file is given (e.g., |
| 253 | using `--file`, `--global`, etc) and `on` when searching all |
| 254 | config files. |
Jeff King | 9b25a0b | 2012-02-06 04:54:04 -0500 | [diff] [blame] | 255 | |
Taylor Blau | eeaa24b | 2018-04-09 17:18:26 -0700 | [diff] [blame] | 256 | --default <value>:: |
| 257 | When using `--get`, and the requested variable is not found, behave as if |
| 258 | <value> were the value assigned to the that variable. |
| 259 | |
Martin Ågren | 32888b8 | 2018-02-21 19:51:43 +0100 | [diff] [blame] | 260 | CONFIGURATION |
| 261 | ------------- |
| 262 | `pager.config` is only respected when listing configuration, i.e., when |
| 263 | using `--list` or any of the `--get-*` which may return multiple results. |
Martin Ågren | c0e9f5b | 2018-02-21 19:51:44 +0100 | [diff] [blame] | 264 | The default is to use a pager. |
Martin Ågren | 32888b8 | 2018-02-21 19:51:43 +0100 | [diff] [blame] | 265 | |
Frank Lichtenheld | 1701409 | 2007-05-31 02:35:37 +0200 | [diff] [blame] | 266 | [[FILES]] |
| 267 | FILES |
| 268 | ----- |
| 269 | |
Matthieu Moy | bcf9626 | 2016-06-28 13:40:11 +0200 | [diff] [blame] | 270 | If not set explicitly with `--file`, there are four files where |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 271 | 'git config' will search for configuration options: |
Frank Lichtenheld | 1701409 | 2007-05-31 02:35:37 +0200 | [diff] [blame] | 272 | |
John Keeping | 7da9800 | 2013-07-07 20:49:56 +0100 | [diff] [blame] | 273 | $(prefix)/etc/gitconfig:: |
| 274 | System-wide configuration file. |
Frank Lichtenheld | 1701409 | 2007-05-31 02:35:37 +0200 | [diff] [blame] | 275 | |
Huynh Khoi Nguyen Nguyen | 21cf322 | 2012-06-22 11:03:23 +0200 | [diff] [blame] | 276 | $XDG_CONFIG_HOME/git/config:: |
| 277 | Second user-specific configuration file. If $XDG_CONFIG_HOME is not set |
Ramkumar Ramachandra | 5ff0c0e | 2013-07-26 16:12:02 +0530 | [diff] [blame] | 278 | or empty, `$HOME/.config/git/config` will be used. Any single-valued |
Huynh Khoi Nguyen Nguyen | 21cf322 | 2012-06-22 11:03:23 +0200 | [diff] [blame] | 279 | variable set in this file will be overwritten by whatever is in |
Ramkumar Ramachandra | 5ff0c0e | 2013-07-26 16:12:02 +0530 | [diff] [blame] | 280 | `~/.gitconfig`. It is a good idea not to create this file if |
Huynh Khoi Nguyen Nguyen | 21cf322 | 2012-06-22 11:03:23 +0200 | [diff] [blame] | 281 | you sometimes use older versions of Git, as support for this |
| 282 | file was added fairly recently. |
| 283 | |
John Keeping | 7da9800 | 2013-07-07 20:49:56 +0100 | [diff] [blame] | 284 | ~/.gitconfig:: |
| 285 | User-specific configuration file. Also called "global" |
| 286 | configuration file. |
| 287 | |
| 288 | $GIT_DIR/config:: |
| 289 | Repository specific configuration file. |
Frank Lichtenheld | 1701409 | 2007-05-31 02:35:37 +0200 | [diff] [blame] | 290 | |
Nguyễn Thái Ngọc Duy | 58b284a | 2018-10-21 16:02:28 +0200 | [diff] [blame] | 291 | $GIT_DIR/config.worktree:: |
| 292 | This is optional and is only searched when |
| 293 | `extensions.worktreeConfig` is present in $GIT_DIR/config. |
| 294 | |
Frank Lichtenheld | 1701409 | 2007-05-31 02:35:37 +0200 | [diff] [blame] | 295 | If no further options are given, all reading options will read all of these |
| 296 | files that are available. If the global or the system-wide configuration |
| 297 | file are not available they will be ignored. If the repository configuration |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 298 | file is not available or readable, 'git config' will exit with a non-zero |
Frank Lichtenheld | 1701409 | 2007-05-31 02:35:37 +0200 | [diff] [blame] | 299 | error code. However, in neither case will an error message be issued. |
| 300 | |
John Keeping | 7da9800 | 2013-07-07 20:49:56 +0100 | [diff] [blame] | 301 | The files are read in the order given above, with last value found taking |
| 302 | precedence over values read earlier. When multiple values are taken then all |
| 303 | values of a key from all files will be used. |
| 304 | |
David Glasser | ae1f709 | 2016-08-23 10:33:21 -0700 | [diff] [blame] | 305 | You may override individual configuration parameters when running any git |
| 306 | command by using the `-c` option. See linkgit:git[1] for details. |
| 307 | |
Frank Lichtenheld | 1701409 | 2007-05-31 02:35:37 +0200 | [diff] [blame] | 308 | All writing options will per default write to the repository specific |
Matthieu Moy | bcf9626 | 2016-06-28 13:40:11 +0200 | [diff] [blame] | 309 | configuration file. Note that this also affects options like `--replace-all` |
| 310 | and `--unset`. *'git config' will only ever change one file at a time*. |
Frank Lichtenheld | 1701409 | 2007-05-31 02:35:37 +0200 | [diff] [blame] | 311 | |
Jason St. John | 06ab60c | 2014-05-21 14:52:26 -0400 | [diff] [blame] | 312 | You can override these rules either by command-line options or by environment |
Nguyễn Thái Ngọc Duy | 58b284a | 2018-10-21 16:02:28 +0200 | [diff] [blame] | 313 | variables. The `--global`, `--system` and `--worktree` options will limit |
| 314 | the file used to the global, system-wide or per-worktree file respectively. |
| 315 | The `GIT_CONFIG` environment variable has a similar effect, but you |
| 316 | can specify any filename you want. |
Frank Lichtenheld | 1701409 | 2007-05-31 02:35:37 +0200 | [diff] [blame] | 317 | |
Frank Lichtenheld | 1701409 | 2007-05-31 02:35:37 +0200 | [diff] [blame] | 318 | |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 319 | ENVIRONMENT |
| 320 | ----------- |
| 321 | |
| 322 | GIT_CONFIG:: |
| 323 | Take the configuration from the given file instead of .git/config. |
Frank Lichtenheld | 1701409 | 2007-05-31 02:35:37 +0200 | [diff] [blame] | 324 | Using the "--global" option forces this to ~/.gitconfig. Using the |
| 325 | "--system" option forces this to $(prefix)/etc/gitconfig. |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 326 | |
Jonathan Nieder | e8ef401 | 2012-10-14 01:53:59 -0700 | [diff] [blame] | 327 | GIT_CONFIG_NOSYSTEM:: |
| 328 | Whether to skip reading settings from the system-wide |
| 329 | $(prefix)/etc/gitconfig file. See linkgit:git[1] for details. |
| 330 | |
Frank Lichtenheld | 1701409 | 2007-05-31 02:35:37 +0200 | [diff] [blame] | 331 | See also <<FILES>>. |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 332 | |
Frank Lichtenheld | 90a36e5 | 2007-05-31 02:35:36 +0200 | [diff] [blame] | 333 | |
| 334 | [[EXAMPLES]] |
| 335 | EXAMPLES |
| 336 | -------- |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 337 | |
| 338 | Given a .git/config like this: |
| 339 | |
| 340 | # |
| 341 | # This is the config file, and |
| 342 | # a '#' or ';' character indicates |
| 343 | # a comment |
| 344 | # |
| 345 | |
| 346 | ; core variables |
| 347 | [core] |
| 348 | ; Don't trust file modes |
| 349 | filemode = false |
| 350 | |
| 351 | ; Our diff algorithm |
| 352 | [diff] |
Anders Melchiorsen | 6bb9e51 | 2008-07-27 13:12:15 +0200 | [diff] [blame] | 353 | external = /usr/local/bin/diff-wrapper |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 354 | renames = true |
| 355 | |
| 356 | ; Proxy settings |
| 357 | [core] |
Junio C Hamano | d1e1fe7 | 2012-08-18 16:35:09 -0700 | [diff] [blame] | 358 | gitproxy=proxy-command for kernel.org |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 359 | gitproxy=default-proxy ; for all the rest |
| 360 | |
Junio C Hamano | d477096 | 2013-07-31 11:14:59 -0700 | [diff] [blame] | 361 | ; HTTP |
| 362 | [http] |
| 363 | sslVerify |
| 364 | [http "https://weak.example.com"] |
| 365 | sslVerify = false |
| 366 | cookieFile = /tmp/cookie.txt |
| 367 | |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 368 | you can set the filemode to true with |
| 369 | |
| 370 | ------------ |
| 371 | % git config core.filemode true |
| 372 | ------------ |
| 373 | |
| 374 | The hypothetical proxy command entries actually have a postfix to discern |
| 375 | what URL they apply to. Here is how to change the entry for kernel.org |
| 376 | to "ssh". |
| 377 | |
| 378 | ------------ |
| 379 | % git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$' |
| 380 | ------------ |
| 381 | |
| 382 | This makes sure that only the key/value pair for kernel.org is replaced. |
| 383 | |
| 384 | To delete the entry for renames, do |
| 385 | |
| 386 | ------------ |
| 387 | % git config --unset diff.renames |
| 388 | ------------ |
| 389 | |
| 390 | If you want to delete an entry for a multivar (like core.gitproxy above), |
| 391 | you have to provide a regex matching the value of exactly one line. |
| 392 | |
| 393 | To query the value for a given key, do |
| 394 | |
| 395 | ------------ |
| 396 | % git config --get core.filemode |
| 397 | ------------ |
| 398 | |
| 399 | or |
| 400 | |
| 401 | ------------ |
| 402 | % git config core.filemode |
| 403 | ------------ |
| 404 | |
| 405 | or, to query a multivar: |
| 406 | |
| 407 | ------------ |
| 408 | % git config --get core.gitproxy "for kernel.org$" |
| 409 | ------------ |
| 410 | |
| 411 | If you want to know all the values for a multivar, do: |
| 412 | |
| 413 | ------------ |
| 414 | % git config --get-all core.gitproxy |
| 415 | ------------ |
| 416 | |
Jim Meyering | 544ddb0 | 2008-12-12 10:00:41 +0100 | [diff] [blame] | 417 | If you like to live dangerously, you can replace *all* core.gitproxy by a |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 418 | new one with |
| 419 | |
| 420 | ------------ |
| 421 | % git config --replace-all core.gitproxy ssh |
| 422 | ------------ |
| 423 | |
| 424 | However, if you really only want to replace the line for the default proxy, |
| 425 | i.e. the one without a "for ..." postfix, do something like this: |
| 426 | |
| 427 | ------------ |
| 428 | % git config core.gitproxy ssh '! for ' |
| 429 | ------------ |
| 430 | |
| 431 | To actually match only values with an exclamation mark, you have to |
| 432 | |
| 433 | ------------ |
| 434 | % git config section.key value '[!]' |
| 435 | ------------ |
| 436 | |
| 437 | To add a new proxy, without altering any of the existing ones, use |
| 438 | |
| 439 | ------------ |
Michael Haggerty | d0714cc | 2012-08-18 19:32:10 +0200 | [diff] [blame] | 440 | % git config --add core.gitproxy '"proxy-command" for example.com' |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 441 | ------------ |
| 442 | |
Junio C Hamano | 9ce0352 | 2007-11-27 22:41:05 -0800 | [diff] [blame] | 443 | An example to use customized color from the configuration in your |
| 444 | script: |
| 445 | |
| 446 | ------------ |
| 447 | #!/bin/sh |
| 448 | WS=$(git config --get-color color.diff.whitespace "blue reverse") |
| 449 | RESET=$(git config --get-color "" "reset") |
| 450 | echo "${WS}your whitespace color or blue reverse${RESET}" |
| 451 | ------------ |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 452 | |
Junio C Hamano | d477096 | 2013-07-31 11:14:59 -0700 | [diff] [blame] | 453 | For URLs in `https://weak.example.com`, `http.sslVerify` is set to |
| 454 | false, while it is set to `true` for all others: |
| 455 | |
| 456 | ------------ |
Martin Ågren | ed3bb3d | 2018-09-19 18:38:18 +0200 | [diff] [blame] | 457 | % git config --type=bool --get-urlmatch http.sslverify https://good.example.com |
Junio C Hamano | d477096 | 2013-07-31 11:14:59 -0700 | [diff] [blame] | 458 | true |
Martin Ågren | ed3bb3d | 2018-09-19 18:38:18 +0200 | [diff] [blame] | 459 | % git config --type=bool --get-urlmatch http.sslverify https://weak.example.com |
Junio C Hamano | d477096 | 2013-07-31 11:14:59 -0700 | [diff] [blame] | 460 | false |
| 461 | % git config --get-urlmatch http https://weak.example.com |
Nguyễn Thái Ngọc Duy | da0005b | 2015-03-11 16:32:45 -0400 | [diff] [blame] | 462 | http.cookieFile /tmp/cookie.txt |
Junio C Hamano | d477096 | 2013-07-31 11:14:59 -0700 | [diff] [blame] | 463 | http.sslverify false |
| 464 | ------------ |
| 465 | |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 466 | include::config.txt[] |
| 467 | |
Stefan Beller | bff7df7 | 2018-08-08 12:50:20 -0700 | [diff] [blame] | 468 | BUGS |
| 469 | ---- |
| 470 | When using the deprecated `[section.subsection]` syntax, changing a value |
| 471 | will result in adding a multi-line key instead of a change, if the subsection |
| 472 | is given with at least one uppercase character. For example when the config |
| 473 | looks like |
| 474 | |
| 475 | -------- |
| 476 | [section.subsection] |
| 477 | key = value1 |
| 478 | -------- |
| 479 | |
| 480 | and running `git config section.Subsection.key value2` will result in |
| 481 | |
| 482 | -------- |
| 483 | [section.subsection] |
| 484 | key = value1 |
| 485 | key = value2 |
| 486 | -------- |
| 487 | |
| 488 | |
Tom Prince | e0d10e1 | 2007-01-28 16:16:53 -0800 | [diff] [blame] | 489 | GIT |
| 490 | --- |
Christian Couder | 9e1f0a8 | 2008-06-06 09:07:32 +0200 | [diff] [blame] | 491 | Part of the linkgit:git[1] suite |