6 git-config - Get and set repository or global options
12 'git config' [<file-option>] [--type=<type>] [--comment=<message>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] <name> [<value> [<value-pattern>]]
13 'git config' [<file-option>] [--type=<type>] [--comment=<message>] --add <name> <value>
14 'git config' [<file-option>] [--type=<type>] [--comment=<message>] [--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.
74 A list of all available configuration variables can be obtained using the
75 `git help --config` command.
82 Default behavior is to replace at most one line. This replaces
83 all lines matching the key (and optionally the `value-pattern`).
86 Adds a new line to the option without altering any existing
87 values. This is the same as providing '^$' as the `value-pattern`
91 Append a comment at the end of new or modified lines.
92 Unless _<message>_ begins with "#", a string "# " (hash
93 followed by a space) is prepended to it. The _<message>_ must not
94 contain linefeed characters (no multi-line comments are permitted).
97 Get the value for a given key (optionally filtered by a regex
98 matching the value). Returns error code 1 if the key was not
99 found and the last value if multiple key values were found.
102 Like get, but returns all values for a multi-valued key.
105 Like --get-all, but interprets the name as a regular expression and
106 writes out the key names. Regular expression matching is currently
107 case-sensitive and done against a canonicalized version of the key
108 in which section and variable names are lowercased, but subsection
111 --get-urlmatch <name> <URL>::
112 When given a two-part <name> as <section>.<key>, the value for
113 <section>.<URL>.<key> whose <URL> part matches the best to the
114 given URL is returned (if no such key exists, the value for
115 <section>.<key> is used as a fallback). When given just the
116 <section> as name, do so for all the keys in the section and
117 list them. Returns error code 1 if no value is found.
120 For writing options: write to global `~/.gitconfig` file
121 rather than the repository `.git/config`, write to
122 `$XDG_CONFIG_HOME/git/config` file if this file exists and the
123 `~/.gitconfig` file doesn't.
125 For reading options: read only from global `~/.gitconfig` and from
126 `$XDG_CONFIG_HOME/git/config` rather than from all available files.
131 For writing options: write to system-wide
132 `$(prefix)/etc/gitconfig` rather than the repository
135 For reading options: read only from system-wide `$(prefix)/etc/gitconfig`
136 rather than from all available files.
141 For writing options: write to the repository `.git/config` file.
142 This is the default behavior.
144 For reading options: read only from the repository `.git/config` rather than
145 from all available files.
150 Similar to `--local` except that `$GIT_DIR/config.worktree` is
151 read from or written to if `extensions.worktreeConfig` is
152 enabled. If not it's the same as `--local`. Note that `$GIT_DIR`
153 is equal to `$GIT_COMMON_DIR` for the main working tree, but is of
154 the form `$GIT_DIR/worktrees/<id>/` for other working trees. See
155 linkgit:git-worktree[1] to learn how to enable
156 `extensions.worktreeConfig`.
159 --file <config-file>::
160 For writing options: write to the specified file rather than the
161 repository `.git/config`.
163 For reading options: read only from the specified file rather than from all
169 Similar to `--file` but use the given blob instead of a file. E.g.
170 you can use 'master:.gitmodules' to read values from the file
171 '.gitmodules' in the master branch. See "SPECIFYING REVISIONS"
172 section in linkgit:gitrevisions[7] for a more complete list of
173 ways to spell blob names.
176 Remove the given section from the configuration file.
179 Rename the given section to a new name.
182 Remove the line matching the key from config file.
185 Remove all lines matching the key from config file.
189 List all variables set in config file, along with their values.
192 When used with the `value-pattern` argument, treat `value-pattern` as
193 an exact string instead of a regular expression. This will restrict
194 the name/value pairs that are matched to only those where the value
195 is exactly equal to the `value-pattern`.
198 'git config' will ensure that any input or output is valid under the given
199 type constraint(s), and will canonicalize outgoing values in `<type>`'s
202 Valid `<type>`'s include:
204 - 'bool': canonicalize values as either "true" or "false".
205 - 'int': canonicalize values as simple decimal numbers. An optional suffix of
206 'k', 'm', or 'g' will cause the value to be multiplied by 1024, 1048576, or
207 1073741824 upon input.
208 - 'bool-or-int': canonicalize according to either 'bool' or 'int', as described
210 - 'path': canonicalize by expanding a leading `~` to the value of `$HOME` and
211 `~user` to the home directory for the specified user. This specifier has no
212 effect when setting the value (but you can use `git config section.variable
213 ~/` from the command line to let your shell do the expansion.)
214 - 'expiry-date': canonicalize by converting from a fixed or relative date-string
215 to a timestamp. This specifier has no effect when setting the value.
216 - 'color': When getting a value, canonicalize by converting to an ANSI color
217 escape sequence. When setting a value, a sanity-check is performed to ensure
218 that the given value is canonicalize-able as an ANSI color, but it is written
227 Historical options for selecting a type specifier. Prefer instead `--type`
231 Un-sets the previously set type specifier (if one was previously set). This
232 option requests that 'git config' not canonicalize the retrieved variable.
233 `--no-type` has no effect without `--type=<type>` or `--<type>`.
237 For all options that output values and/or keys, always
238 end values with the null character (instead of a
239 newline). Use newline instead as a delimiter between
240 key and value. This allows for secure parsing of the
241 output without getting confused e.g. by values that
245 Output only the names of config variables for `--list` or
249 Augment the output of all queried config options with the
250 origin type (file, standard input, blob, command line) and
251 the actual origin (config file path, ref, or blob id if
255 Similar to `--show-origin` in that it augments the output of
256 all queried config options with the scope of that value
257 (worktree, local, global, system, command).
259 --get-colorbool <name> [<stdout-is-tty>]::
261 Find the color setting for `<name>` (e.g. `color.diff`) and output
262 "true" or "false". `<stdout-is-tty>` should be either "true" or
263 "false", and is taken into account when configuration says
264 "auto". If `<stdout-is-tty>` is missing, then checks the standard
265 output of the command itself, and exits with status 0 if color
266 is to be used, or exits with status 1 otherwise.
267 When the color setting for `name` is undefined, the command uses
268 `color.ui` as fallback.
270 --get-color <name> [<default>]::
272 Find the color configured for `name` (e.g. `color.diff.new`) and
273 output it as the ANSI color escape sequence to the standard
274 output. The optional `default` parameter is used instead, if
275 there is no color configured for `name`.
277 `--type=color [--default=<default>]` is preferred over `--get-color`
278 (but note that `--get-color` will omit the trailing newline printed by
283 Opens an editor to modify the specified config file; either
284 `--system`, `--global`, or repository (default).
287 Respect `include.*` directives in config files when looking up
288 values. Defaults to `off` when a specific file is given (e.g.,
289 using `--file`, `--global`, etc) and `on` when searching all
293 When using `--get`, and the requested variable is not found, behave as if
294 <value> were the value assigned to the that variable.
298 `pager.config` is only respected when listing configuration, i.e., when
299 using `--list` or any of the `--get-*` which may return multiple results.
300 The default is to use a pager.
306 By default, 'git config' will read configuration options from multiple
309 $(prefix)/etc/gitconfig::
310 System-wide configuration file.
312 $XDG_CONFIG_HOME/git/config::
314 User-specific configuration files. When the XDG_CONFIG_HOME environment
315 variable is not set or empty, $HOME/.config/ is used as
318 These are also called "global" configuration files. If both files exist, both
319 files are read in the order given above.
322 Repository specific configuration file.
324 $GIT_DIR/config.worktree::
325 This is optional and is only searched when
326 `extensions.worktreeConfig` is present in $GIT_DIR/config.
328 You may also provide additional configuration parameters when running any
329 git command by using the `-c` option. See linkgit:git[1] for details.
331 Options will be read from all of these files that are available. If the
332 global or the system-wide configuration files are missing or unreadable they
333 will be ignored. If the repository configuration file is missing or unreadable,
334 'git config' will exit with a non-zero error code. An error message is produced
335 if the file is unreadable, but not if it is missing.
337 The files are read in the order given above, with last value found taking
338 precedence over values read earlier. When multiple values are taken then all
339 values of a key from all files will be used.
341 By default, options are only written to the repository specific
342 configuration file. Note that this also affects options like `--replace-all`
343 and `--unset`. *'git config' will only ever change one file at a time*.
345 You can limit which configuration sources are read from or written to by
346 specifying the path of a file with the `--file` option, or by specifying a
347 configuration scope with `--system`, `--global`, `--local`, or `--worktree`.
348 For more, see <<OPTIONS>> above.
354 Each configuration source falls within a configuration scope. The scopes
358 $(prefix)/etc/gitconfig
361 $XDG_CONFIG_HOME/git/config
369 $GIT_DIR/config.worktree
372 GIT_CONFIG_{COUNT,KEY,VALUE} environment variables (see <<ENVIRONMENT>>
377 With the exception of 'command', each scope corresponds to a command line
378 option: `--system`, `--global`, `--local`, `--worktree`.
380 When reading options, specifying a scope will only read options from the
381 files within that scope. When writing options, specifying a scope will write
382 to the files within that scope (instead of the repository specific
383 configuration file). See <<OPTIONS>> above for a complete description.
385 Most configuration options are respected regardless of the scope it is
386 defined in, but some options are only respected in certain scopes. See the
387 respective option's documentation for the full details.
389 Protected configuration
390 ~~~~~~~~~~~~~~~~~~~~~~~
392 Protected configuration refers to the 'system', 'global', and 'command' scopes.
393 For security reasons, certain options are only respected when they are
394 specified in protected configuration, and ignored otherwise.
396 Git treats these scopes as if they are controlled by the user or a trusted
397 administrator. This is because an attacker who controls these scopes can do
398 substantial harm without using Git, so it is assumed that the user's environment
399 protects these scopes against attackers.
407 Take the configuration from the given files instead from global or
408 system-level configuration. See linkgit:git[1] for details.
410 GIT_CONFIG_NOSYSTEM::
411 Whether to skip reading settings from the system-wide
412 $(prefix)/etc/gitconfig file. See linkgit:git[1] for details.
418 GIT_CONFIG_VALUE_<n>::
419 If GIT_CONFIG_COUNT is set to a positive number, all environment pairs
420 GIT_CONFIG_KEY_<n> and GIT_CONFIG_VALUE_<n> up to that number will be
421 added to the process's runtime configuration. The config pairs are
422 zero-indexed. Any missing key or value is treated as an error. An empty
423 GIT_CONFIG_COUNT is treated the same as GIT_CONFIG_COUNT=0, namely no
424 pairs are processed. These environment variables will override values
425 in configuration files, but will be overridden by any explicit options
428 This is useful for cases where you want to spawn multiple git commands
429 with a common configuration but cannot depend on a configuration file,
430 for example when writing scripts.
433 If no `--file` option is provided to `git config`, use the file
434 given by `GIT_CONFIG` as if it were provided via `--file`. This
435 variable has no effect on other Git commands, and is mostly for
436 historical compatibility; there is generally no reason to use it
437 instead of the `--file` option.
443 Given a .git/config like this:
447 # This is the config file, and
448 # a '#' or ';' character indicates
454 ; Don't trust file modes
459 external = /usr/local/bin/diff-wrapper
464 gitproxy=proxy-command for kernel.org
465 gitproxy=default-proxy ; for all the rest
470 [http "https://weak.example.com"]
472 cookieFile = /tmp/cookie.txt
475 you can set the filemode to true with
478 % git config core.filemode true
481 The hypothetical proxy command entries actually have a postfix to discern
482 what URL they apply to. Here is how to change the entry for kernel.org
486 % git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
489 This makes sure that only the key/value pair for kernel.org is replaced.
491 To delete the entry for renames, do
494 % git config --unset diff.renames
497 If you want to delete an entry for a multivar (like core.gitproxy above),
498 you have to provide a regex matching the value of exactly one line.
500 To query the value for a given key, do
503 % git config --get core.filemode
509 % git config core.filemode
512 or, to query a multivar:
515 % git config --get core.gitproxy "for kernel.org$"
518 If you want to know all the values for a multivar, do:
521 % git config --get-all core.gitproxy
524 If you like to live dangerously, you can replace *all* core.gitproxy by a
528 % git config --replace-all core.gitproxy ssh
531 However, if you really only want to replace the line for the default proxy,
532 i.e. the one without a "for ..." postfix, do something like this:
535 % git config core.gitproxy ssh '! for '
538 To actually match only values with an exclamation mark, you have to
541 % git config section.key value '[!]'
544 To add a new proxy, without altering any of the existing ones, use
547 % git config --add core.gitproxy '"proxy-command" for example.com'
550 An example to use customized color from the configuration in your
555 WS=$(git config --get-color color.diff.whitespace "blue reverse")
556 RESET=$(git config --get-color "" "reset")
557 echo "${WS}your whitespace color or blue reverse${RESET}"
560 For URLs in `https://weak.example.com`, `http.sslVerify` is set to
561 false, while it is set to `true` for all others:
564 % git config --type=bool --get-urlmatch http.sslverify https://good.example.com
566 % git config --type=bool --get-urlmatch http.sslverify https://weak.example.com
568 % git config --get-urlmatch http https://weak.example.com
569 http.cookieFile /tmp/cookie.txt
573 include::config.txt[]
577 When using the deprecated `[section.subsection]` syntax, changing a value
578 will result in adding a multi-line key instead of a change, if the subsection
579 is given with at least one uppercase character. For example when the config
587 and running `git config section.Subsection.key value2` will result in
598 Part of the linkgit:git[1] suite