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] [--show-origin] [-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] [--show-origin] [-z|--null] --get name [value_regex] 16'git config' [<file-option>] [type] [--show-origin] [-z|--null] --get-all name [value_regex] 17'git config' [<file-option>] [type] [--show-origin] [-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>] [--show-origin] [-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 section or key is invalid (ret=1), 62- no section or name was provided (ret=2), 63- the config file is invalid (ret=3), 64- the config file cannot be written (ret=4), 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 a leading `~` to the value of 178 `$HOME`, and `~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 section.variable ~/` 181 from the command line to let your shell do the expansion). 182 183--expiry-date:: 184 `git config` will ensure that the output is converted from 185 a fixed or relative date-string to a timestamp. This option 186 has no effect when setting the value. 187 188-z:: 189--null:: 190 For all options that output values and/or keys, always 191 end values with the null character (instead of a 192 newline). Use newline instead as a delimiter between 193 key and value. This allows for secure parsing of the 194 output without getting confused e.g. by values that 195 contain line breaks. 196 197--name-only:: 198 Output only the names of config variables for `--list` or 199 `--get-regexp`. 200 201--show-origin:: 202 Augment the output of all queried config options with the 203 origin type (file, standard input, blob, command line) and 204 the actual origin (config file path, ref, or blob id if 205 applicable). 206 207--get-colorbool name [stdout-is-tty]:: 208 209 Find the color setting for `name` (e.g. `color.diff`) and output 210 "true" or "false". `stdout-is-tty` should be either "true" or 211 "false", and is taken into account when configuration says 212 "auto". If `stdout-is-tty` is missing, then checks the standard 213 output of the command itself, and exits with status 0 if color 214 is to be used, or exits with status 1 otherwise. 215 When the color setting for `name` is undefined, the command uses 216 `color.ui` as fallback. 217 218--get-color name [default]:: 219 220 Find the color configured for `name` (e.g. `color.diff.new`) and 221 output it as the ANSI color escape sequence to the standard 222 output. The optional `default` parameter is used instead, if 223 there is no color configured for `name`. 224 225-e:: 226--edit:: 227 Opens an editor to modify the specified config file; either 228 `--system`, `--global`, or repository (default). 229 230--[no-]includes:: 231 Respect `include.*` directives in config files when looking up 232 values. Defaults to `off` when a specific file is given (e.g., 233 using `--file`, `--global`, etc) and `on` when searching all 234 config files. 235 236CONFIGURATION 237------------- 238`pager.config` is only respected when listing configuration, i.e., when 239using `--list` or any of the `--get-*` which may return multiple results. 240 241[[FILES]] 242FILES 243----- 244 245If not set explicitly with `--file`, there are four files where 246'git config' will search for configuration options: 247 248$(prefix)/etc/gitconfig:: 249 System-wide configuration file. 250 251$XDG_CONFIG_HOME/git/config:: 252 Second user-specific configuration file. If $XDG_CONFIG_HOME is not set 253 or empty, `$HOME/.config/git/config` will be used. Any single-valued 254 variable set in this file will be overwritten by whatever is in 255 `~/.gitconfig`. It is a good idea not to create this file if 256 you sometimes use older versions of Git, as support for this 257 file was added fairly recently. 258 259~/.gitconfig:: 260 User-specific configuration file. Also called "global" 261 configuration file. 262 263$GIT_DIR/config:: 264 Repository specific configuration file. 265 266If no further options are given, all reading options will read all of these 267files that are available. If the global or the system-wide configuration 268file are not available they will be ignored. If the repository configuration 269file is not available or readable, 'git config' will exit with a non-zero 270error code. However, in neither case will an error message be issued. 271 272The files are read in the order given above, with last value found taking 273precedence over values read earlier. When multiple values are taken then all 274values of a key from all files will be used. 275 276You may override individual configuration parameters when running any git 277command by using the `-c` option. See linkgit:git[1] for details. 278 279All writing options will per default write to the repository specific 280configuration file. Note that this also affects options like `--replace-all` 281and `--unset`. *'git config' will only ever change one file at a time*. 282 283You can override these rules either by command-line options or by environment 284variables. The `--global` and the `--system` options will limit the file used 285to the global or system-wide file respectively. The `GIT_CONFIG` environment 286variable has a similar effect, but you can specify any filename you want. 287 288 289ENVIRONMENT 290----------- 291 292GIT_CONFIG:: 293 Take the configuration from the given file instead of .git/config. 294 Using the "--global" option forces this to ~/.gitconfig. Using the 295 "--system" option forces this to $(prefix)/etc/gitconfig. 296 297GIT_CONFIG_NOSYSTEM:: 298 Whether to skip reading settings from the system-wide 299 $(prefix)/etc/gitconfig file. See linkgit:git[1] for details. 300 301See also <<FILES>>. 302 303 304[[EXAMPLES]] 305EXAMPLES 306-------- 307 308Given a .git/config like this: 309 310 # 311 # This is the config file, and 312 # a '#' or ';' character indicates 313 # a comment 314 # 315 316 ; core variables 317 [core] 318 ; Don't trust file modes 319 filemode = false 320 321 ; Our diff algorithm 322 [diff] 323 external = /usr/local/bin/diff-wrapper 324 renames = true 325 326 ; Proxy settings 327 [core] 328 gitproxy=proxy-command for kernel.org 329 gitproxy=default-proxy ; for all the rest 330 331 ; HTTP 332 [http] 333 sslVerify 334 [http "https://weak.example.com"] 335 sslVerify = false 336 cookieFile = /tmp/cookie.txt 337 338you can set the filemode to true with 339 340------------ 341% git config core.filemode true 342------------ 343 344The hypothetical proxy command entries actually have a postfix to discern 345what URL they apply to. Here is how to change the entry for kernel.org 346to "ssh". 347 348------------ 349% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$' 350------------ 351 352This makes sure that only the key/value pair for kernel.org is replaced. 353 354To delete the entry for renames, do 355 356------------ 357% git config --unset diff.renames 358------------ 359 360If you want to delete an entry for a multivar (like core.gitproxy above), 361you have to provide a regex matching the value of exactly one line. 362 363To query the value for a given key, do 364 365------------ 366% git config --get core.filemode 367------------ 368 369or 370 371------------ 372% git config core.filemode 373------------ 374 375or, to query a multivar: 376 377------------ 378% git config --get core.gitproxy "for kernel.org$" 379------------ 380 381If you want to know all the values for a multivar, do: 382 383------------ 384% git config --get-all core.gitproxy 385------------ 386 387If you like to live dangerously, you can replace *all* core.gitproxy by a 388new one with 389 390------------ 391% git config --replace-all core.gitproxy ssh 392------------ 393 394However, if you really only want to replace the line for the default proxy, 395i.e. the one without a "for ..." postfix, do something like this: 396 397------------ 398% git config core.gitproxy ssh '! for ' 399------------ 400 401To actually match only values with an exclamation mark, you have to 402 403------------ 404% git config section.key value '[!]' 405------------ 406 407To add a new proxy, without altering any of the existing ones, use 408 409------------ 410% git config --add core.gitproxy '"proxy-command" for example.com' 411------------ 412 413An example to use customized color from the configuration in your 414script: 415 416------------ 417#!/bin/sh 418WS=$(git config --get-color color.diff.whitespace "blue reverse") 419RESET=$(git config --get-color "" "reset") 420echo "${WS}your whitespace color or blue reverse${RESET}" 421------------ 422 423For URLs in `https://weak.example.com`, `http.sslVerify` is set to 424false, while it is set to `true` for all others: 425 426------------ 427% git config --bool --get-urlmatch http.sslverify https://good.example.com 428true 429% git config --bool --get-urlmatch http.sslverify https://weak.example.com 430false 431% git config --get-urlmatch http https://weak.example.com 432http.cookieFile /tmp/cookie.txt 433http.sslverify false 434------------ 435 436include::config.txt[] 437 438GIT 439--- 440Part of the linkgit:git[1] suite