1git-config(1) 2============= 3 4NAME 5---- 6git-config - Get and set repository or global options 7 8 9SYNOPSIS 10-------- 11[verse] 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] [--name-only] --get-regexp name_regex [value_regex] 18'git config' [<file-option>] [type] [-z|--null] --get-urlmatch name URL 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 23'git config' [<file-option>] [-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 27 28DESCRIPTION 29----------- 30You can query/set/replace/unset options with this command. The name is 31actually the section and the key separated by a dot, and the value will be 32escaped. 33 34Multiple lines can be added to an option by using the '--add' option. 35If you want to update or unset an option which can occur on multiple 36lines, a POSIX regexp `value_regex` needs to be given. Only the 37existing values that match the regexp are updated or unset. If 38you want to handle the lines that do *not* match the regex, just 39prepend a single exclamation mark in front (see also <<EXAMPLES>>). 40 41The type specifier can be either '--int' or '--bool', to make 42'git config' ensure that the variable(s) are of the given type and 43convert the value to the canonical form (simple decimal number for int, 44a "true" or "false" string for bool), or '--path', which does some 45path expansion (see '--path' below). If no type specifier is passed, no 46checks or transformations are performed on the value. 47 48When reading, the values are read from the system, global and 49repository local configuration files by default, and options 50'--system', '--global', '--local' and '--file <filename>' can be 51used to tell the command to read from only that location (see <<FILES>>). 52 53When writing, the new value is written to the repository local 54configuration file by default, and options '--system', '--global', 55'--file <filename>' can be used to tell the command to write to 56that location (you can say '--local' but that is the default). 57 58This command will fail with non-zero status upon error. Some exit 59codes are: 60 61- The config file is invalid (ret=3), 62- can not write to the config file (ret=4), 63- no section or name was provided (ret=2), 64- the section or key is invalid (ret=1), 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). 68 69On success, the command returns the exit code 0. 70 71OPTIONS 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 80 values. This is the same as providing '^$' as the value_regex 81 in `--replace-all`. 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 86 found and the last value if multiple key values were found. 87 88--get-all:: 89 Like get, but returns all values for a multi-valued key. 90 91--get-regexp:: 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. 97 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 104 list them. Returns error code 1 if no value is found. 105 106--global:: 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. 111+ 112For reading options: read only from global `~/.gitconfig` and from 113`$XDG_CONFIG_HOME/git/config` rather than from all available files. 114+ 115See also <<FILES>>. 116 117--system:: 118 For writing options: write to system-wide 119 `$(prefix)/etc/gitconfig` rather than the repository 120 `.git/config`. 121+ 122For reading options: read only from system-wide `$(prefix)/etc/gitconfig` 123rather than from all available files. 124+ 125See also <<FILES>>. 126 127--local:: 128 For writing options: write to the repository `.git/config` file. 129 This is the default behavior. 130+ 131For reading options: read only from the repository `.git/config` rather than 132from all available files. 133+ 134See also <<FILES>>. 135 136-f config-file:: 137--file config-file:: 138 Use the given config file instead of the one specified by GIT_CONFIG. 139 140--blob blob:: 141 Similar to '--file' but use the given blob instead of a file. E.g. 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 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 153--unset:: 154 Remove the line matching the key from config file. 155 156--unset-all:: 157 Remove all lines matching the key from config file. 158 159-l:: 160--list:: 161 List all variables set in config file, along with their values. 162 163--bool:: 164 'git config' will ensure that the output is "true" or "false" 165 166--int:: 167 'git config' will ensure that the output is a simple 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 172--bool-or-int:: 173 'git config' will ensure that the output matches the format of 174 either --bool or --int, as described above. 175 176--path:: 177 'git-config' will expand leading '{tilde}' to the value of 178 '$HOME', and '{tilde}user' to the home directory for the 179 specified user. This option has no effect when setting the 180 value (but you can use 'git config bla {tilde}/' from the 181 command line to let your shell do the expansion). 182 183-z:: 184--null:: 185 For all options that output values and/or keys, always 186 end values with the null character (instead of a 187 newline). Use newline instead as a delimiter between 188 key and value. This allows for secure parsing of the 189 output without getting confused e.g. by values that 190 contain line breaks. 191 192--name-only:: 193 Output only the names of config variables for `--list` or 194 `--get-regexp`. 195 196--get-colorbool name [stdout-is-tty]:: 197 198 Find the color setting for `name` (e.g. `color.diff`) and output 199 "true" or "false". `stdout-is-tty` should be either "true" or 200 "false", and is taken into account when configuration says 201 "auto". If `stdout-is-tty` is missing, then checks the standard 202 output of the command itself, and exits with status 0 if color 203 is to be used, or exits with status 1 otherwise. 204 When the color setting for `name` is undefined, the command uses 205 `color.ui` as fallback. 206 207--get-color name [default]:: 208 209 Find the color configured for `name` (e.g. `color.diff.new`) and 210 output it as the ANSI color escape sequence to the standard 211 output. The optional `default` parameter is used instead, if 212 there is no color configured for `name`. 213 214-e:: 215--edit:: 216 Opens an editor to modify the specified config file; either 217 '--system', '--global', or repository (default). 218 219--[no-]includes:: 220 Respect `include.*` directives in config files when looking up 221 values. Defaults to on. 222 223[[FILES]] 224FILES 225----- 226 227If not set explicitly with '--file', there are four files where 228'git config' will search for configuration options: 229 230$(prefix)/etc/gitconfig:: 231 System-wide configuration file. 232 233$XDG_CONFIG_HOME/git/config:: 234 Second user-specific configuration file. If $XDG_CONFIG_HOME is not set 235 or empty, `$HOME/.config/git/config` will be used. Any single-valued 236 variable set in this file will be overwritten by whatever is in 237 `~/.gitconfig`. It is a good idea not to create this file if 238 you sometimes use older versions of Git, as support for this 239 file was added fairly recently. 240 241~/.gitconfig:: 242 User-specific configuration file. Also called "global" 243 configuration file. 244 245$GIT_DIR/config:: 246 Repository specific configuration file. 247 248If no further options are given, all reading options will read all of these 249files that are available. If the global or the system-wide configuration 250file are not available they will be ignored. If the repository configuration 251file is not available or readable, 'git config' will exit with a non-zero 252error code. However, in neither case will an error message be issued. 253 254The files are read in the order given above, with last value found taking 255precedence over values read earlier. When multiple values are taken then all 256values of a key from all files will be used. 257 258All writing options will per default write to the repository specific 259configuration file. Note that this also affects options like '--replace-all' 260and '--unset'. *'git config' will only ever change one file at a time*. 261 262You can override these rules either by command-line options or by environment 263variables. The '--global' and the '--system' options will limit the file used 264to the global or system-wide file respectively. The GIT_CONFIG environment 265variable has a similar effect, but you can specify any filename you want. 266 267 268ENVIRONMENT 269----------- 270 271GIT_CONFIG:: 272 Take the configuration from the given file instead of .git/config. 273 Using the "--global" option forces this to ~/.gitconfig. Using the 274 "--system" option forces this to $(prefix)/etc/gitconfig. 275 276GIT_CONFIG_NOSYSTEM:: 277 Whether to skip reading settings from the system-wide 278 $(prefix)/etc/gitconfig file. See linkgit:git[1] for details. 279 280See also <<FILES>>. 281 282 283[[EXAMPLES]] 284EXAMPLES 285-------- 286 287Given a .git/config like this: 288 289 # 290 # This is the config file, and 291 # a '#' or ';' character indicates 292 # a comment 293 # 294 295 ; core variables 296 [core] 297 ; Don't trust file modes 298 filemode = false 299 300 ; Our diff algorithm 301 [diff] 302 external = /usr/local/bin/diff-wrapper 303 renames = true 304 305 ; Proxy settings 306 [core] 307 gitproxy=proxy-command for kernel.org 308 gitproxy=default-proxy ; for all the rest 309 310 ; HTTP 311 [http] 312 sslVerify 313 [http "https://weak.example.com"] 314 sslVerify = false 315 cookieFile = /tmp/cookie.txt 316 317you can set the filemode to true with 318 319------------ 320% git config core.filemode true 321------------ 322 323The hypothetical proxy command entries actually have a postfix to discern 324what URL they apply to. Here is how to change the entry for kernel.org 325to "ssh". 326 327------------ 328% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$' 329------------ 330 331This makes sure that only the key/value pair for kernel.org is replaced. 332 333To delete the entry for renames, do 334 335------------ 336% git config --unset diff.renames 337------------ 338 339If you want to delete an entry for a multivar (like core.gitproxy above), 340you have to provide a regex matching the value of exactly one line. 341 342To query the value for a given key, do 343 344------------ 345% git config --get core.filemode 346------------ 347 348or 349 350------------ 351% git config core.filemode 352------------ 353 354or, to query a multivar: 355 356------------ 357% git config --get core.gitproxy "for kernel.org$" 358------------ 359 360If you want to know all the values for a multivar, do: 361 362------------ 363% git config --get-all core.gitproxy 364------------ 365 366If you like to live dangerously, you can replace *all* core.gitproxy by a 367new one with 368 369------------ 370% git config --replace-all core.gitproxy ssh 371------------ 372 373However, if you really only want to replace the line for the default proxy, 374i.e. the one without a "for ..." postfix, do something like this: 375 376------------ 377% git config core.gitproxy ssh '! for ' 378------------ 379 380To actually match only values with an exclamation mark, you have to 381 382------------ 383% git config section.key value '[!]' 384------------ 385 386To add a new proxy, without altering any of the existing ones, use 387 388------------ 389% git config --add core.gitproxy '"proxy-command" for example.com' 390------------ 391 392An example to use customized color from the configuration in your 393script: 394 395------------ 396#!/bin/sh 397WS=$(git config --get-color color.diff.whitespace "blue reverse") 398RESET=$(git config --get-color "" "reset") 399echo "${WS}your whitespace color or blue reverse${RESET}" 400------------ 401 402For URLs in `https://weak.example.com`, `http.sslVerify` is set to 403false, while it is set to `true` for all others: 404 405------------ 406% git config --bool --get-urlmatch http.sslverify https://good.example.com 407true 408% git config --bool --get-urlmatch http.sslverify https://weak.example.com 409false 410% git config --get-urlmatch http https://weak.example.com 411http.cookieFile /tmp/cookie.txt 412http.sslverify false 413------------ 414 415include::config.txt[] 416 417GIT 418--- 419Part of the linkgit:git[1] suite