6 git-config - Get and set repository or global options
12 'git config' [<file-option>] [--type=<type>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] name [value [value-pattern]]
13 'git config' [<file-option>] [--type=<type>] --add name value
14 'git config' [<file-option>] [--type=<type>] [--fixed-value] --replace-all name value [value-pattern]
15 'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get name [value-pattern]
16 'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all name [value-pattern]
17 'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp name_regex [value-pattern]
18 'git config' [<file-option>] [--type=<type>] [-z|--null] --get-urlmatch name URL
19 'git config' [<file-option>] [--fixed-value] --unset name [value-pattern]
20 'git config' [<file-option>] [--fixed-value] --unset-all name [value-pattern]
21 'git config' [<file-option>] --rename-section old_name new_name
22 'git config' [<file-option>] --remove-section name
23 'git config' [<file-option>] [--show-origin] [--show-scope] [-z|--null] [--name-only] -l | --list
24 'git config' [<file-option>] --get-color name [default]
25 'git config' [<file-option>] --get-colorbool name [stdout-is-tty]
26 'git config' [<file-option>] -e | --edit
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
34 Multiple lines can be added to an option by using the `--add` option.
35 If you want to update or unset an option which can occur on multiple
36 lines, a `value-pattern` (which is an extended regular expression,
37 unless the `--fixed-value` option is given) needs to be given. Only the
38 existing values that match the pattern are updated or unset. If
39 you want to handle the lines that do *not* match the pattern, just
40 prepend a single exclamation mark in front (see also <<EXAMPLES>>),
41 but note that this only works when the `--fixed-value` option is not
44 The `--type=<type>` option instructs 'git config' to ensure that incoming and
45 outgoing values are canonicalize-able under the given <type>. If no
46 `--type=<type>` is given, no canonicalization will be performed. Callers may
47 unset an existing `--type` specifier with `--no-type`.
49 When reading, the values are read from the system, global and
50 repository local configuration files by default, and options
51 `--system`, `--global`, `--local`, `--worktree` and
52 `--file <filename>` can be used to tell the command to read from only
53 that location (see <<FILES>>).
55 When writing, the new value is written to the repository local
56 configuration file by default, and options `--system`, `--global`,
57 `--worktree`, `--file <filename>` can be used to tell the command to
58 write to that location (you can say `--local` but that is the
61 This command will fail with non-zero status upon error. Some exit
64 - The section or key is invalid (ret=1),
65 - no section or name was provided (ret=2),
66 - the config file is invalid (ret=3),
67 - the config file cannot be written (ret=4),
68 - you try to unset an option which does not exist (ret=5),
69 - you try to unset/set an option for which multiple lines match (ret=5), or
70 - you try to use an invalid regexp (ret=6).
72 On success, the command returns the exit code 0.
79 Default behavior is to replace at most one line. This replaces
80 all lines matching the key (and optionally the `value-pattern`).
83 Adds a new line to the option without altering any existing
84 values. This is the same as providing '^$' as the `value-pattern`
88 Get the value for a given key (optionally filtered by a regex
89 matching the value). Returns error code 1 if the key was not
90 found and the last value if multiple key values were found.
93 Like get, but returns all values for a multi-valued key.
96 Like --get-all, but interprets the name as a regular expression and
97 writes out the key names. Regular expression matching is currently
98 case-sensitive and done against a canonicalized version of the key
99 in which section and variable names are lowercased, but subsection
102 --get-urlmatch name URL::
103 When given a two-part name section.key, the value for
104 section.<url>.key whose <url> part matches the best to the
105 given URL is returned (if no such key exists, the value for
106 section.key is used as a fallback). When given just the
107 section as name, do so for all the keys in the section and
108 list them. Returns error code 1 if no value is found.
111 For writing options: write to global `~/.gitconfig` file
112 rather than the repository `.git/config`, write to
113 `$XDG_CONFIG_HOME/git/config` file if this file exists and the
114 `~/.gitconfig` file doesn't.
116 For reading options: read only from global `~/.gitconfig` and from
117 `$XDG_CONFIG_HOME/git/config` rather than from all available files.
122 For writing options: write to system-wide
123 `$(prefix)/etc/gitconfig` rather than the repository
126 For reading options: read only from system-wide `$(prefix)/etc/gitconfig`
127 rather than from all available files.
132 For writing options: write to the repository `.git/config` file.
133 This is the default behavior.
135 For reading options: read only from the repository `.git/config` rather than
136 from all available files.
141 Similar to `--local` except that `.git/config.worktree` is
142 read from or written to if `extensions.worktreeConfig` is
143 present. If not it's the same as `--local`.
147 For writing options: write to the specified file rather than the
148 repository `.git/config`.
150 For reading options: read only from the specified file rather than from all
156 Similar to `--file` but use the given blob instead of a file. E.g.
157 you can use 'master:.gitmodules' to read values from the file
158 '.gitmodules' in the master branch. See "SPECIFYING REVISIONS"
159 section in linkgit:gitrevisions[7] for a more complete list of
160 ways to spell blob names.
163 Remove the given section from the configuration file.
166 Rename the given section to a new name.
169 Remove the line matching the key from config file.
172 Remove all lines matching the key from config file.
176 List all variables set in config file, along with their values.
179 When used with the `value-pattern` argument, treat `value-pattern` as
180 an exact string instead of a regular expression. This will restrict
181 the name/value pairs that are matched to only those where the value
182 is exactly equal to the `value-pattern`.
185 'git config' will ensure that any input or output is valid under the given
186 type constraint(s), and will canonicalize outgoing values in `<type>`'s
189 Valid `<type>`'s include:
191 - 'bool': canonicalize values as either "true" or "false".
192 - 'int': canonicalize values as simple decimal numbers. An optional suffix of
193 'k', 'm', or 'g' will cause the value to be multiplied by 1024, 1048576, or
194 1073741824 upon input.
195 - 'bool-or-int': canonicalize according to either 'bool' or 'int', as described
197 - 'path': canonicalize by adding a leading `~` to the value of `$HOME` and
198 `~user` to the home directory for the specified user. This specifier has no
199 effect when setting the value (but you can use `git config section.variable
200 ~/` from the command line to let your shell do the expansion.)
201 - 'expiry-date': canonicalize by converting from a fixed or relative date-string
202 to a timestamp. This specifier has no effect when setting the value.
203 - 'color': When getting a value, canonicalize by converting to an ANSI color
204 escape sequence. When setting a value, a sanity-check is performed to ensure
205 that the given value is canonicalize-able as an ANSI color, but it is written
214 Historical options for selecting a type specifier. Prefer instead `--type`
218 Un-sets the previously set type specifier (if one was previously set). This
219 option requests that 'git config' not canonicalize the retrieved variable.
220 `--no-type` has no effect without `--type=<type>` or `--<type>`.
224 For all options that output values and/or keys, always
225 end values with the null character (instead of a
226 newline). Use newline instead as a delimiter between
227 key and value. This allows for secure parsing of the
228 output without getting confused e.g. by values that
232 Output only the names of config variables for `--list` or
236 Augment the output of all queried config options with the
237 origin type (file, standard input, blob, command line) and
238 the actual origin (config file path, ref, or blob id if
242 Similar to `--show-origin` in that it augments the output of
243 all queried config options with the scope of that value
244 (local, global, system, command).
246 --get-colorbool name [stdout-is-tty]::
248 Find the color setting for `name` (e.g. `color.diff`) and output
249 "true" or "false". `stdout-is-tty` should be either "true" or
250 "false", and is taken into account when configuration says
251 "auto". If `stdout-is-tty` is missing, then checks the standard
252 output of the command itself, and exits with status 0 if color
253 is to be used, or exits with status 1 otherwise.
254 When the color setting for `name` is undefined, the command uses
255 `color.ui` as fallback.
257 --get-color name [default]::
259 Find the color configured for `name` (e.g. `color.diff.new`) and
260 output it as the ANSI color escape sequence to the standard
261 output. The optional `default` parameter is used instead, if
262 there is no color configured for `name`.
264 `--type=color [--default=<default>]` is preferred over `--get-color`
265 (but note that `--get-color` will omit the trailing newline printed by
270 Opens an editor to modify the specified config file; either
271 `--system`, `--global`, or repository (default).
274 Respect `include.*` directives in config files when looking up
275 values. Defaults to `off` when a specific file is given (e.g.,
276 using `--file`, `--global`, etc) and `on` when searching all
280 When using `--get`, and the requested variable is not found, behave as if
281 <value> were the value assigned to the that variable.
285 `pager.config` is only respected when listing configuration, i.e., when
286 using `--list` or any of the `--get-*` which may return multiple results.
287 The default is to use a pager.
293 If not set explicitly with `--file`, there are four files where
294 'git config' will search for configuration options:
296 $(prefix)/etc/gitconfig::
297 System-wide configuration file.
299 $XDG_CONFIG_HOME/git/config::
300 Second user-specific configuration file. If $XDG_CONFIG_HOME is not set
301 or empty, `$HOME/.config/git/config` will be used. Any single-valued
302 variable set in this file will be overwritten by whatever is in
303 `~/.gitconfig`. It is a good idea not to create this file if
304 you sometimes use older versions of Git, as support for this
305 file was added fairly recently.
308 User-specific configuration file. Also called "global"
312 Repository specific configuration file.
314 $GIT_DIR/config.worktree::
315 This is optional and is only searched when
316 `extensions.worktreeConfig` is present in $GIT_DIR/config.
318 If no further options are given, all reading options will read all of these
319 files that are available. If the global or the system-wide configuration
320 file are not available they will be ignored. If the repository configuration
321 file is not available or readable, 'git config' will exit with a non-zero
322 error code. However, in neither case will an error message be issued.
324 The files are read in the order given above, with last value found taking
325 precedence over values read earlier. When multiple values are taken then all
326 values of a key from all files will be used.
328 You may override individual configuration parameters when running any git
329 command by using the `-c` option. See linkgit:git[1] for details.
331 All writing options will per default write to the repository specific
332 configuration file. Note that this also affects options like `--replace-all`
333 and `--unset`. *'git config' will only ever change one file at a time*.
335 You can override these rules using the `--global`, `--system`,
336 `--local`, `--worktree`, and `--file` command-line options; see
345 Take the configuration from the given files instead from global or
346 system-level configuration. See linkgit:git[1] for details.
348 GIT_CONFIG_NOSYSTEM::
349 Whether to skip reading settings from the system-wide
350 $(prefix)/etc/gitconfig file. See linkgit:git[1] for details.
356 GIT_CONFIG_VALUE_<n>::
357 If GIT_CONFIG_COUNT is set to a positive number, all environment pairs
358 GIT_CONFIG_KEY_<n> and GIT_CONFIG_VALUE_<n> up to that number will be
359 added to the process's runtime configuration. The config pairs are
360 zero-indexed. Any missing key or value is treated as an error. An empty
361 GIT_CONFIG_COUNT is treated the same as GIT_CONFIG_COUNT=0, namely no
362 pairs are processed. These environment variables will override values
363 in configuration files, but will be overridden by any explicit options
366 This is useful for cases where you want to spawn multiple git commands
367 with a common configuration but cannot depend on a configuration file,
368 for example when writing scripts.
371 If no `--file` option is provided to `git config`, use the file
372 given by `GIT_CONFIG` as if it were provided via `--file`. This
373 variable has no effect on other Git commands, and is mostly for
374 historical compatibility; there is generally no reason to use it
375 instead of the `--file` option.
381 Given a .git/config like this:
385 # This is the config file, and
386 # a '#' or ';' character indicates
392 ; Don't trust file modes
397 external = /usr/local/bin/diff-wrapper
402 gitproxy=proxy-command for kernel.org
403 gitproxy=default-proxy ; for all the rest
408 [http "https://weak.example.com"]
410 cookieFile = /tmp/cookie.txt
413 you can set the filemode to true with
416 % git config core.filemode true
419 The hypothetical proxy command entries actually have a postfix to discern
420 what URL they apply to. Here is how to change the entry for kernel.org
424 % git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
427 This makes sure that only the key/value pair for kernel.org is replaced.
429 To delete the entry for renames, do
432 % git config --unset diff.renames
435 If you want to delete an entry for a multivar (like core.gitproxy above),
436 you have to provide a regex matching the value of exactly one line.
438 To query the value for a given key, do
441 % git config --get core.filemode
447 % git config core.filemode
450 or, to query a multivar:
453 % git config --get core.gitproxy "for kernel.org$"
456 If you want to know all the values for a multivar, do:
459 % git config --get-all core.gitproxy
462 If you like to live dangerously, you can replace *all* core.gitproxy by a
466 % git config --replace-all core.gitproxy ssh
469 However, if you really only want to replace the line for the default proxy,
470 i.e. the one without a "for ..." postfix, do something like this:
473 % git config core.gitproxy ssh '! for '
476 To actually match only values with an exclamation mark, you have to
479 % git config section.key value '[!]'
482 To add a new proxy, without altering any of the existing ones, use
485 % git config --add core.gitproxy '"proxy-command" for example.com'
488 An example to use customized color from the configuration in your
493 WS=$(git config --get-color color.diff.whitespace "blue reverse")
494 RESET=$(git config --get-color "" "reset")
495 echo "${WS}your whitespace color or blue reverse${RESET}"
498 For URLs in `https://weak.example.com`, `http.sslVerify` is set to
499 false, while it is set to `true` for all others:
502 % git config --type=bool --get-urlmatch http.sslverify https://good.example.com
504 % git config --type=bool --get-urlmatch http.sslverify https://weak.example.com
506 % git config --get-urlmatch http https://weak.example.com
507 http.cookieFile /tmp/cookie.txt
511 include::config.txt[]
515 When using the deprecated `[section.subsection]` syntax, changing a value
516 will result in adding a multi-line key instead of a change, if the subsection
517 is given with at least one uppercase character. For example when the config
525 and running `git config section.Subsection.key value2` will result in
536 Part of the linkgit:git[1] suite