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