6 git-config - Get and set repository or global options
12 'git config' [<file-option>] [type] [-z|--null] name [value [value_regex]]
13 'git config' [<file-option>] [type] --add name value
14 'git config' [<file-option>] [type] --replace-all name value [value_regex]
15 'git config' [<file-option>] [type] [-z|--null] --get name [value_regex]
16 'git config' [<file-option>] [type] [-z|--null] --get-all name [value_regex]
17 'git config' [<file-option>] [type] [-z|--null] --get-regexp name_regex [value_regex]
18 'git config' [<file-option>] --unset name [value_regex]
19 'git config' [<file-option>] --unset-all name [value_regex]
20 'git config' [<file-option>] --rename-section old_name new_name
21 'git config' [<file-option>] --remove-section name
22 'git config' [<file-option>] [-z|--null] -l | --list
23 'git config' [<file-option>] --get-color name [default]
24 'git config' [<file-option>] --get-colorbool name [stdout-is-tty]
25 'git config' [<file-option>] -e | --edit
29 You can query/set/replace/unset options with this command. The name is
30 actually the section and the key separated by a dot, and the value will be
33 Multiple lines can be added to an option by using the '--add' option.
34 If you want to update or unset an option which can occur on multiple
35 lines, a POSIX regexp `value_regex` needs to be given. Only the
36 existing values that match the regexp are updated or unset. If
37 you want to handle the lines that do *not* match the regex, just
38 prepend a single exclamation mark in front (see also <<EXAMPLES>>).
40 The type specifier can be either '--int' or '--bool', to make
41 'git config' ensure that the variable(s) are of the given type and
42 convert the value to the canonical form (simple decimal number for int,
43 a "true" or "false" string for bool), or '--path', which does some
44 path expansion (see '--path' below). If no type specifier is passed, no
45 checks or transformations are performed on the value.
47 The file-option can be one of '--system', '--global' or '--file'
48 which specify where the values will be read from or written to.
49 The default is to assume the config file of the current repository,
50 .git/config unless defined otherwise with GIT_DIR and GIT_CONFIG
53 This command will fail (with exit code ret) if:
55 . The config file is invalid (ret=3),
56 . can not write to the config file (ret=4),
57 . no section or name was provided (ret=2),
58 . the section or key is invalid (ret=1),
59 . you try to unset an option which does not exist (ret=5),
60 . you try to unset/set an option for which multiple lines match (ret=5),
61 . you try to use an invalid regexp (ret=6), or
62 . you use '--global' option without $HOME being properly set (ret=128).
64 On success, the command returns the exit code 0.
70 Default behavior is to replace at most one line. This replaces
71 all lines matching the key (and optionally the value_regex).
74 Adds a new line to the option without altering any existing
75 values. This is the same as providing '^$' as the value_regex
79 Get the value for a given key (optionally filtered by a regex
80 matching the value). Returns error code 1 if the key was not
81 found and error code 2 if multiple key values were found.
84 Like get, but does not fail if the number of values for the key
88 Like --get-all, but interprets the name as a regular expression and
89 writes out the key names. Regular expression matching is currently
90 case-sensitive and done against a canonicalized version of the key
91 in which section and variable names are lowercased, but subsection
95 For writing options: write to global ~/.gitconfig file rather than
96 the repository .git/config.
98 For reading options: read only from global ~/.gitconfig rather than
99 from all available files.
104 For writing options: write to system-wide $(prefix)/etc/gitconfig
105 rather than the repository .git/config.
107 For reading options: read only from system-wide $(prefix)/etc/gitconfig
108 rather than from all available files.
114 Use the given config file instead of the one specified by GIT_CONFIG.
117 Remove the given section from the configuration file.
120 Rename the given section to a new name.
123 Remove the line matching the key from config file.
126 Remove all lines matching the key from config file.
130 List all variables set in config file.
133 'git config' will ensure that the output is "true" or "false"
136 'git config' will ensure that the output is a simple
137 decimal number. An optional value suffix of 'k', 'm', or 'g'
138 in the config file will cause the value to be multiplied
139 by 1024, 1048576, or 1073741824 prior to output.
142 'git config' will ensure that the output matches the format of
143 either --bool or --int, as described above.
146 'git-config' will expand leading '{tilde}' to the value of
147 '$HOME', and '{tilde}user' to the home directory for the
148 specified user. This option has no effect when setting the
149 value (but you can use 'git config bla {tilde}/' from the
150 command line to let your shell do the expansion).
154 For all options that output values and/or keys, always
155 end values with the null character (instead of a
156 newline). Use newline instead as a delimiter between
157 key and value. This allows for secure parsing of the
158 output without getting confused e.g. by values that
161 --get-colorbool name [stdout-is-tty]::
163 Find the color setting for `name` (e.g. `color.diff`) and output
164 "true" or "false". `stdout-is-tty` should be either "true" or
165 "false", and is taken into account when configuration says
166 "auto". If `stdout-is-tty` is missing, then checks the standard
167 output of the command itself, and exits with status 0 if color
168 is to be used, or exits with status 1 otherwise.
169 When the color setting for `name` is undefined, the command uses
170 `color.ui` as fallback.
172 --get-color name [default]::
174 Find the color configured for `name` (e.g. `color.diff.new`) and
175 output it as the ANSI color escape sequence to the standard
176 output. The optional `default` parameter is used instead, if
177 there is no color configured for `name`.
181 Opens an editor to modify the specified config file; either
182 '--system', '--global', or repository (default).
188 If not set explicitly with '--file', there are three files where
189 'git config' will search for configuration options:
192 Repository specific configuration file. (The filename is
193 of course relative to the repository root, not the working
197 User-specific configuration file. Also called "global"
200 $(prefix)/etc/gitconfig::
201 System-wide configuration file.
203 If no further options are given, all reading options will read all of these
204 files that are available. If the global or the system-wide configuration
205 file are not available they will be ignored. If the repository configuration
206 file is not available or readable, 'git config' will exit with a non-zero
207 error code. However, in neither case will an error message be issued.
209 All writing options will per default write to the repository specific
210 configuration file. Note that this also affects options like '--replace-all'
211 and '--unset'. *'git config' will only ever change one file at a time*.
213 You can override these rules either by command line options or by environment
214 variables. The '--global' and the '--system' options will limit the file used
215 to the global or system-wide file respectively. The GIT_CONFIG environment
216 variable has a similar effect, but you can specify any filename you want.
223 Take the configuration from the given file instead of .git/config.
224 Using the "--global" option forces this to ~/.gitconfig. Using the
225 "--system" option forces this to $(prefix)/etc/gitconfig.
234 Given a .git/config like this:
237 # This is the config file, and
238 # a '#' or ';' character indicates
244 ; Don't trust file modes
249 external = /usr/local/bin/diff-wrapper
254 gitproxy="proxy-command" for kernel.org
255 gitproxy=default-proxy ; for all the rest
257 you can set the filemode to true with
260 % git config core.filemode true
263 The hypothetical proxy command entries actually have a postfix to discern
264 what URL they apply to. Here is how to change the entry for kernel.org
268 % git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
271 This makes sure that only the key/value pair for kernel.org is replaced.
273 To delete the entry for renames, do
276 % git config --unset diff.renames
279 If you want to delete an entry for a multivar (like core.gitproxy above),
280 you have to provide a regex matching the value of exactly one line.
282 To query the value for a given key, do
285 % git config --get core.filemode
291 % git config core.filemode
294 or, to query a multivar:
297 % git config --get core.gitproxy "for kernel.org$"
300 If you want to know all the values for a multivar, do:
303 % git config --get-all core.gitproxy
306 If you like to live dangerously, you can replace *all* core.gitproxy by a
310 % git config --replace-all core.gitproxy ssh
313 However, if you really only want to replace the line for the default proxy,
314 i.e. the one without a "for ..." postfix, do something like this:
317 % git config core.gitproxy ssh '! for '
320 To actually match only values with an exclamation mark, you have to
323 % git config section.key value '[!]'
326 To add a new proxy, without altering any of the existing ones, use
329 % git config --add core.gitproxy '"proxy-command" for example.com'
332 An example to use customized color from the configuration in your
337 WS=$(git config --get-color color.diff.whitespace "blue reverse")
338 RESET=$(git config --get-color "" "reset")
339 echo "${WS}your whitespace color or blue reverse${RESET}"
342 include::config.txt[]
346 Part of the linkgit:git[1] suite