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] --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 26DESCRIPTION 27----------- 28You can query/set/replace/unset options with this command. The name is 29actually the section and the key separated by a dot, and the value will be 30escaped. 31 32Multiple lines can be added to an option by using the '--add' option. 33If you want to update or unset an option which can occur on multiple 34lines, a POSIX regexp `value_regex` needs to be given. Only the 35existing values that match the regexp are updated or unset. If 36you want to handle the lines that do *not* match the regex, just 37prepend a single exclamation mark in front (see also <<EXAMPLES>>). 38 39The type specifier can be either '--int' or '--bool', which will make 40'git-config' ensure that the variable(s) are of the given type and 41convert the value to the canonical form (simple decimal number for int, 42a "true" or "false" string for bool). If no type specifier is passed, 43no checks or transformations are performed on the value. 44 45The file-option can be one of '--system', '--global' or '--file' 46which specify where the values will be read from or written to. 47The default is to assume the config file of the current repository, 48.git/config unless defined otherwise with GIT_DIR and GIT_CONFIG 49(see <<FILES>>). 50 51This command will fail if: 52 53. The config file is invalid, 54. Can not write to the config file, 55. no section was provided, 56. the section or key is invalid, 57. you try to unset an option which does not exist, 58. you try to unset/set an option for which multiple lines match, or 59. you use '--global' option without $HOME being properly set. 60 61 62OPTIONS 63------- 64 65--replace-all:: 66 Default behavior is to replace at most one line. This replaces 67 all lines matching the key (and optionally the value_regex). 68 69--add:: 70 Adds a new line to the option without altering any existing 71 values. This is the same as providing '^$' as the value_regex. 72 73--get:: 74 Get the value for a given key (optionally filtered by a regex 75 matching the value). Returns error code 1 if the key was not 76 found and error code 2 if multiple key values were found. 77 78--get-all:: 79 Like get, but does not fail if the number of values for the key 80 is not exactly one. 81 82--get-regexp:: 83 Like --get-all, but interprets the name as a regular expression. 84 Also outputs the key names. 85 86--global:: 87 For writing options: write to global ~/.gitconfig file rather than 88 the repository .git/config. 89+ 90For reading options: read only from global ~/.gitconfig rather than 91from all available files. 92+ 93See also <<FILES>>. 94 95--system:: 96 For writing options: write to system-wide $(prefix)/etc/gitconfig 97 rather than the repository .git/config. 98+ 99For reading options: read only from system-wide $(prefix)/etc/gitconfig 100rather than from all available files. 101+ 102See also <<FILES>>. 103 104-f config-file:: 105--file config-file:: 106 Use the given config file instead of the one specified by GIT_CONFIG. 107 108--remove-section:: 109 Remove the given section from the configuration file. 110 111--rename-section:: 112 Rename the given section to a new name. 113 114--unset:: 115 Remove the line matching the key from config file. 116 117--unset-all:: 118 Remove all lines matching the key from config file. 119 120-l:: 121--list:: 122 List all variables set in config file. 123 124--bool:: 125 'git-config' will ensure that the output is "true" or "false" 126 127--int:: 128 'git-config' will ensure that the output is a simple 129 decimal number. An optional value suffix of 'k', 'm', or 'g' 130 in the config file will cause the value to be multiplied 131 by 1024, 1048576, or 1073741824 prior to output. 132 133--bool-or-int:: 134 'git-config' will ensure that the output matches the format of 135 either --bool or --int, as described above. 136 137-z:: 138--null:: 139 For all options that output values and/or keys, always 140 end values with the null character (instead of a 141 newline). Use newline instead as a delimiter between 142 key and value. This allows for secure parsing of the 143 output without getting confused e.g. by values that 144 contain line breaks. 145 146--get-colorbool name [stdout-is-tty]:: 147 148 Find the color setting for `name` (e.g. `color.diff`) and output 149 "true" or "false". `stdout-is-tty` should be either "true" or 150 "false", and is taken into account when configuration says 151 "auto". If `stdout-is-tty` is missing, then checks the standard 152 output of the command itself, and exits with status 0 if color 153 is to be used, or exits with status 1 otherwise. 154 When the color setting for `name` is undefined, the command uses 155 `color.ui` as fallback. 156 157--get-color name default:: 158 159 Find the color configured for `name` (e.g. `color.diff.new`) and 160 output it as the ANSI color escape sequence to the standard 161 output. The optional `default` parameter is used instead, if 162 there is no color configured for `name`. 163 164[[FILES]] 165FILES 166----- 167 168If not set explicitly with '--file', there are three files where 169'git-config' will search for configuration options: 170 171$GIT_DIR/config:: 172 Repository specific configuration file. (The filename is 173 of course relative to the repository root, not the working 174 directory.) 175 176~/.gitconfig:: 177 User-specific configuration file. Also called "global" 178 configuration file. 179 180$(prefix)/etc/gitconfig:: 181 System-wide configuration file. 182 183If no further options are given, all reading options will read all of these 184files that are available. If the global or the system-wide configuration 185file are not available they will be ignored. If the repository configuration 186file is not available or readable, 'git-config' will exit with a non-zero 187error code. However, in neither case will an error message be issued. 188 189All writing options will per default write to the repository specific 190configuration file. Note that this also affects options like '--replace-all' 191and '--unset'. *'git-config' will only ever change one file at a time*. 192 193You can override these rules either by command line options or by environment 194variables. The '--global' and the '--system' options will limit the file used 195to the global or system-wide file respectively. The GIT_CONFIG environment 196variable has a similar effect, but you can specify any filename you want. 197 198 199ENVIRONMENT 200----------- 201 202GIT_CONFIG:: 203 Take the configuration from the given file instead of .git/config. 204 Using the "--global" option forces this to ~/.gitconfig. Using the 205 "--system" option forces this to $(prefix)/etc/gitconfig. 206 207See also <<FILES>>. 208 209 210[[EXAMPLES]] 211EXAMPLES 212-------- 213 214Given a .git/config like this: 215 216 # 217 # This is the config file, and 218 # a '#' or ';' character indicates 219 # a comment 220 # 221 222 ; core variables 223 [core] 224 ; Don't trust file modes 225 filemode = false 226 227 ; Our diff algorithm 228 [diff] 229 external = /usr/local/bin/diff-wrapper 230 renames = true 231 232 ; Proxy settings 233 [core] 234 gitproxy="proxy-command" for kernel.org 235 gitproxy=default-proxy ; for all the rest 236 237you can set the filemode to true with 238 239------------ 240% git config core.filemode true 241------------ 242 243The hypothetical proxy command entries actually have a postfix to discern 244what URL they apply to. Here is how to change the entry for kernel.org 245to "ssh". 246 247------------ 248% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$' 249------------ 250 251This makes sure that only the key/value pair for kernel.org is replaced. 252 253To delete the entry for renames, do 254 255------------ 256% git config --unset diff.renames 257------------ 258 259If you want to delete an entry for a multivar (like core.gitproxy above), 260you have to provide a regex matching the value of exactly one line. 261 262To query the value for a given key, do 263 264------------ 265% git config --get core.filemode 266------------ 267 268or 269 270------------ 271% git config core.filemode 272------------ 273 274or, to query a multivar: 275 276------------ 277% git config --get core.gitproxy "for kernel.org$" 278------------ 279 280If you want to know all the values for a multivar, do: 281 282------------ 283% git config --get-all core.gitproxy 284------------ 285 286If you like to live dangerously, you can replace *all* core.gitproxy by a 287new one with 288 289------------ 290% git config --replace-all core.gitproxy ssh 291------------ 292 293However, if you really only want to replace the line for the default proxy, 294i.e. the one without a "for ..." postfix, do something like this: 295 296------------ 297% git config core.gitproxy ssh '! for ' 298------------ 299 300To actually match only values with an exclamation mark, you have to 301 302------------ 303% git config section.key value '[!]' 304------------ 305 306To add a new proxy, without altering any of the existing ones, use 307 308------------ 309% git config core.gitproxy '"proxy-command" for example.com' 310------------ 311 312An example to use customized color from the configuration in your 313script: 314 315------------ 316#!/bin/sh 317WS=$(git config --get-color color.diff.whitespace "blue reverse") 318RESET=$(git config --get-color "" "reset") 319echo "${WS}your whitespace color or blue reverse${RESET}" 320------------ 321 322include::config.txt[] 323 324 325Author 326------ 327Written by Johannes Schindelin <Johannes.Schindelin@gmx.de> 328 329Documentation 330-------------- 331Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>. 332 333GIT 334--- 335Part of the linkgit:git[1] suite