Documentation/git-config.txt

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