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