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=<type>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] name [value [value-pattern]]
  13 'git config' [<file-option>] [--type=<type>] --add name value
  14 'git config' [<file-option>] [--type=<type>] [--fixed-value] --replace-all name value [value-pattern]
  15 'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get name [value-pattern]
  16 'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all name [value-pattern]
  17 'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp name_regex [value-pattern]
  18 'git config' [<file-option>] [--type=<type>] [-z|--null] --get-urlmatch name URL
  19 'git config' [<file-option>] [--fixed-value] --unset name [value-pattern]
  20 'git config' [<file-option>] [--fixed-value] --unset-all name [value-pattern]
  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] [--show-scope] [-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
  28 DESCRIPTION
  29 -----------
  30 You can query/set/replace/unset options with this command. The name is
  31 actually the section and the key separated by a dot, and the value will be
  32 escaped.
  33
  34 Multiple lines can be added to an option by using the `--add` option.
  35 If you want to update or unset an option which can occur on multiple
  36 lines, a `value-pattern` (which is an extended regular expression,
  37 unless the `--fixed-value` option is given) needs to be given.  Only the
  38 existing values that match the pattern are updated or unset.  If
  39 you want to handle the lines that do *not* match the pattern, just
  40 prepend a single exclamation mark in front (see also <<EXAMPLES>>),
  41 but note that this only works when the `--fixed-value` option is not
  42 in use.
  43
  44 The `--type=<type>` option instructs 'git config' to ensure that incoming and
  45 outgoing values are canonicalize-able under the given <type>.  If no
  46 `--type=<type>` is given, no canonicalization will be performed. Callers may
  47 unset an existing `--type` specifier with `--no-type`.
  48
  49 When reading, the values are read from the system, global and
  50 repository local configuration files by default, and options
  51 `--system`, `--global`, `--local`, `--worktree` and
  52 `--file <filename>` can be used to tell the command to read from only
  53 that location (see <<FILES>>).
  54
  55 When writing, the new value is written to the repository local
  56 configuration file by default, and options `--system`, `--global`,
  57 `--worktree`, `--file <filename>` can be used to tell the command to
  58 write to that location (you can say `--local` but that is the
  59 default).
  60
  61 This command will fail with non-zero status upon error.  Some exit
  62 codes are:
  63
  64 - The section or key is invalid (ret=1),
  65 - no section or name was provided (ret=2),
  66 - the config file is invalid (ret=3),
  67 - the config file cannot be written (ret=4),
  68 - you try to unset an option which does not exist (ret=5),
  69 - you try to unset/set an option for which multiple lines match (ret=5), or
  70 - you try to use an invalid regexp (ret=6).
  71
  72 On success, the command returns the exit code 0.
  73
  74 OPTIONS
  75 -------
  76
  77 --replace-all::
  78         Default behavior is to replace at most one line. This replaces
  79         all lines matching the key (and optionally the `value-pattern`).
  80
  81 --add::
  82         Adds a new line to the option without altering any existing
  83         values.  This is the same as providing '^$' as the `value-pattern`
  84         in `--replace-all`.
  85
  86 --get::
  87         Get the value for a given key (optionally filtered by a regex
  88         matching the value). Returns error code 1 if the key was not
  89         found and the last value if multiple key values were found.
  90
  91 --get-all::
  92         Like get, but returns all values for a multi-valued key.
  93
  94 --get-regexp::
  95         Like --get-all, but interprets the name as a regular expression and
  96         writes out the key names.  Regular expression matching is currently
  97         case-sensitive and done against a canonicalized version of the key
  98         in which section and variable names are lowercased, but subsection
  99         names are not.
 100
 101 --get-urlmatch name URL::
 102         When given a two-part name section.key, the value for
 103         section.<url>.key whose <url> part matches the best to the
 104         given URL is returned (if no such key exists, the value for
 105         section.key is used as a fallback).  When given just the
 106         section as name, do so for all the keys in the section and
 107         list them.  Returns error code 1 if no value is found.
 108
 109 --global::
 110         For writing options: write to global `~/.gitconfig` file
 111         rather than the repository `.git/config`, write to
 112         `$XDG_CONFIG_HOME/git/config` file if this file exists and the
 113         `~/.gitconfig` file doesn't.
 114 +
 115 For reading options: read only from global `~/.gitconfig` and from
 116 `$XDG_CONFIG_HOME/git/config` rather than from all available files.
 117 +
 118 See also <<FILES>>.
 119
 120 --system::
 121         For writing options: write to system-wide
 122         `$(prefix)/etc/gitconfig` rather than the repository
 123         `.git/config`.
 124 +
 125 For reading options: read only from system-wide `$(prefix)/etc/gitconfig`
 126 rather than from all available files.
 127 +
 128 See also <<FILES>>.
 129
 130 --local::
 131         For writing options: write to the repository `.git/config` file.
 132         This is the default behavior.
 133 +
 134 For reading options: read only from the repository `.git/config` rather than
 135 from all available files.
 136 +
 137 See also <<FILES>>.
 138
 139 --worktree::
 140         Similar to `--local` except that `.git/config.worktree` is
 141         read from or written to if `extensions.worktreeConfig` is
 142         present. If not it's the same as `--local`.
 143
 144 -f config-file::
 145 --file config-file::
 146         Use the given config file instead of the one specified by GIT_CONFIG.
 147
 148 --blob blob::
 149         Similar to `--file` but use the given blob instead of a file. E.g.
 150         you can use 'master:.gitmodules' to read values from the file
 151         '.gitmodules' in the master branch. See "SPECIFYING REVISIONS"
 152         section in linkgit:gitrevisions[7] for a more complete list of
 153         ways to spell blob names.
 154
 155 --remove-section::
 156         Remove the given section from the configuration file.
 157
 158 --rename-section::
 159         Rename the given section to a new name.
 160
 161 --unset::
 162         Remove the line matching the key from config file.
 163
 164 --unset-all::
 165         Remove all lines matching the key from config file.
 166
 167 -l::
 168 --list::
 169         List all variables set in config file, along with their values.
 170
 171 --fixed-value::
 172         When used with the `value-pattern` argument, treat `value-pattern` as
 173         an exact string instead of a regular expression. This will restrict
 174         the name/value pairs that are matched to only those where the value
 175         is exactly equal to the `value-pattern`.
 176
 177 --type <type>::
 178   'git config' will ensure that any input or output is valid under the given
 179   type constraint(s), and will canonicalize outgoing values in `<type>`'s
 180   canonical form.
 181 +
 182 Valid `<type>`'s include:
 183 +
 184 - 'bool': canonicalize values as either "true" or "false".
 185 - 'int': canonicalize values as simple decimal numbers. An optional suffix of
 186   'k', 'm', or 'g' will cause the value to be multiplied by 1024, 1048576, or
 187   1073741824 upon input.
 188 - 'bool-or-int': canonicalize according to either 'bool' or 'int', as described
 189   above.
 190 - 'path': canonicalize by adding a leading `~` to the value of `$HOME` and
 191   `~user` to the home directory for the specified user. This specifier has no
 192   effect when setting the value (but you can use `git config section.variable
 193   ~/` from the command line to let your shell do the expansion.)
 194 - 'expiry-date': canonicalize by converting from a fixed or relative date-string
 195   to a timestamp. This specifier has no effect when setting the value.
 196 - 'color': When getting a value, canonicalize by converting to an ANSI color
 197   escape sequence. When setting a value, a sanity-check is performed to ensure
 198   that the given value is canonicalize-able as an ANSI color, but it is written
 199   as-is.
 200 +
 201
 202 --bool::
 203 --int::
 204 --bool-or-int::
 205 --path::
 206 --expiry-date::
 207   Historical options for selecting a type specifier. Prefer instead `--type`
 208   (see above).
 209
 210 --no-type::
 211   Un-sets the previously set type specifier (if one was previously set). This
 212   option requests that 'git config' not canonicalize the retrieved variable.
 213   `--no-type` has no effect without `--type=<type>` or `--<type>`.
 214
 215 -z::
 216 --null::
 217         For all options that output values and/or keys, always
 218         end values with the null character (instead of a
 219         newline). Use newline instead as a delimiter between
 220         key and value. This allows for secure parsing of the
 221         output without getting confused e.g. by values that
 222         contain line breaks.
 223
 224 --name-only::
 225         Output only the names of config variables for `--list` or
 226         `--get-regexp`.
 227
 228 --show-origin::
 229         Augment the output of all queried config options with the
 230         origin type (file, standard input, blob, command line) and
 231         the actual origin (config file path, ref, or blob id if
 232         applicable).
 233
 234 --show-scope::
 235         Similar to `--show-origin` in that it augments the output of
 236         all queried config options with the scope of that value
 237         (local, global, system, command).
 238
 239 --get-colorbool name [stdout-is-tty]::
 240
 241         Find the color setting for `name` (e.g. `color.diff`) and output
 242         "true" or "false".  `stdout-is-tty` should be either "true" or
 243         "false", and is taken into account when configuration says
 244         "auto".  If `stdout-is-tty` is missing, then checks the standard
 245         output of the command itself, and exits with status 0 if color
 246         is to be used, or exits with status 1 otherwise.
 247         When the color setting for `name` is undefined, the command uses
 248         `color.ui` as fallback.
 249
 250 --get-color name [default]::
 251
 252         Find the color configured for `name` (e.g. `color.diff.new`) and
 253         output it as the ANSI color escape sequence to the standard
 254         output.  The optional `default` parameter is used instead, if
 255         there is no color configured for `name`.
 256 +
 257 `--type=color [--default=<default>]` is preferred over `--get-color`
 258 (but note that `--get-color` will omit the trailing newline printed by
 259 `--type=color`).
 260
 261 -e::
 262 --edit::
 263         Opens an editor to modify the specified config file; either
 264         `--system`, `--global`, or repository (default).
 265
 266 --[no-]includes::
 267         Respect `include.*` directives in config files when looking up
 268         values. Defaults to `off` when a specific file is given (e.g.,
 269         using `--file`, `--global`, etc) and `on` when searching all
 270         config files.
 271
 272 --default <value>::
 273   When using `--get`, and the requested variable is not found, behave as if
 274   <value> were the value assigned to the that variable.
 275
 276 CONFIGURATION
 277 -------------
 278 `pager.config` is only respected when listing configuration, i.e., when
 279 using `--list` or any of the `--get-*` which may return multiple results.
 280 The default is to use a pager.
 281
 282 [[FILES]]
 283 FILES
 284 -----
 285
 286 If not set explicitly with `--file`, there are four files where
 287 'git config' will search for configuration options:
 288
 289 $(prefix)/etc/gitconfig::
 290         System-wide configuration file.
 291
 292 $XDG_CONFIG_HOME/git/config::
 293         Second user-specific configuration file. If $XDG_CONFIG_HOME is not set
 294         or empty, `$HOME/.config/git/config` will be used. Any single-valued
 295         variable set in this file will be overwritten by whatever is in
 296         `~/.gitconfig`.  It is a good idea not to create this file if
 297         you sometimes use older versions of Git, as support for this
 298         file was added fairly recently.
 299
 300 ~/.gitconfig::
 301         User-specific configuration file. Also called "global"
 302         configuration file.
 303
 304 $GIT_DIR/config::
 305         Repository specific configuration file.
 306
 307 $GIT_DIR/config.worktree::
 308         This is optional and is only searched when
 309         `extensions.worktreeConfig` is present in $GIT_DIR/config.
 310
 311 If no further options are given, all reading options will read all of these
 312 files that are available. If the global or the system-wide configuration
 313 file are not available they will be ignored. If the repository configuration
 314 file is not available or readable, 'git config' will exit with a non-zero
 315 error code. However, in neither case will an error message be issued.
 316
 317 The files are read in the order given above, with last value found taking
 318 precedence over values read earlier.  When multiple values are taken then all
 319 values of a key from all files will be used.
 320
 321 You may override individual configuration parameters when running any git
 322 command by using the `-c` option. See linkgit:git[1] for details.
 323
 324 All writing options will per default write to the repository specific
 325 configuration file. Note that this also affects options like `--replace-all`
 326 and `--unset`. *'git config' will only ever change one file at a time*.
 327
 328 You can override these rules either by command-line options or by environment
 329 variables. The `--global`, `--system` and `--worktree` options will limit
 330 the file used to the global, system-wide or per-worktree file respectively.
 331 The `GIT_CONFIG` environment variable has a similar effect, but you
 332 can specify any filename you want.
 333
 334
 335 ENVIRONMENT
 336 -----------
 337
 338 GIT_CONFIG::
 339         Take the configuration from the given file instead of .git/config.
 340         Using the "--global" option forces this to ~/.gitconfig. Using the
 341         "--system" option forces this to $(prefix)/etc/gitconfig.
 342
 343 GIT_CONFIG_NOSYSTEM::
 344         Whether to skip reading settings from the system-wide
 345         $(prefix)/etc/gitconfig file. See linkgit:git[1] for details.
 346
 347 See also <<FILES>>.
 348
 349 GIT_CONFIG_COUNT::
 350 GIT_CONFIG_KEY_<n>::
 351 GIT_CONFIG_VALUE_<n>::
 352         If GIT_CONFIG_COUNT is set to a positive number, all environment pairs
 353         GIT_CONFIG_KEY_<n> and GIT_CONFIG_VALUE_<n> up to that number will be
 354         added to the process's runtime configuration. The config pairs are
 355         zero-indexed. Any missing key or value is treated as an error. An empty
 356         GIT_CONFIG_COUNT is treated the same as GIT_CONFIG_COUNT=0, namely no
 357         pairs are processed. These environment variables will override values
 358         in configuration files, but will be overridden by any explicit options
 359         passed via `git -c`.
 360 +
 361 This is useful for cases where you want to spawn multiple git commands
 362 with a common configuration but cannot depend on a configuration file,
 363 for example when writing scripts.
 364
 365
 366 [[EXAMPLES]]
 367 EXAMPLES
 368 --------
 369
 370 Given a .git/config like this:
 371
 372 ------------
 373 #
 374 # This is the config file, and
 375 # a '#' or ';' character indicates
 376 # a comment
 377 #
 378
 379 ; core variables
 380 [core]
 381         ; Don't trust file modes
 382         filemode = false
 383
 384 ; Our diff algorithm
 385 [diff]
 386         external = /usr/local/bin/diff-wrapper
 387         renames = true
 388
 389 ; Proxy settings
 390 [core]
 391         gitproxy=proxy-command for kernel.org
 392         gitproxy=default-proxy ; for all the rest
 393
 394 ; HTTP
 395 [http]
 396         sslVerify
 397 [http "https://weak.example.com"]
 398         sslVerify = false
 399         cookieFile = /tmp/cookie.txt
 400 ------------
 401
 402 you can set the filemode to true with
 403
 404 ------------
 405 % git config core.filemode true
 406 ------------
 407
 408 The hypothetical proxy command entries actually have a postfix to discern
 409 what URL they apply to. Here is how to change the entry for kernel.org
 410 to "ssh".
 411
 412 ------------
 413 % git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
 414 ------------
 415
 416 This makes sure that only the key/value pair for kernel.org is replaced.
 417
 418 To delete the entry for renames, do
 419
 420 ------------
 421 % git config --unset diff.renames
 422 ------------
 423
 424 If you want to delete an entry for a multivar (like core.gitproxy above),
 425 you have to provide a regex matching the value of exactly one line.
 426
 427 To query the value for a given key, do
 428
 429 ------------
 430 % git config --get core.filemode
 431 ------------
 432
 433 or
 434
 435 ------------
 436 % git config core.filemode
 437 ------------
 438
 439 or, to query a multivar:
 440
 441 ------------
 442 % git config --get core.gitproxy "for kernel.org$"
 443 ------------
 444
 445 If you want to know all the values for a multivar, do:
 446
 447 ------------
 448 % git config --get-all core.gitproxy
 449 ------------
 450
 451 If you like to live dangerously, you can replace *all* core.gitproxy by a
 452 new one with
 453
 454 ------------
 455 % git config --replace-all core.gitproxy ssh
 456 ------------
 457
 458 However, if you really only want to replace the line for the default proxy,
 459 i.e. the one without a "for ..." postfix, do something like this:
 460
 461 ------------
 462 % git config core.gitproxy ssh '! for '
 463 ------------
 464
 465 To actually match only values with an exclamation mark, you have to
 466
 467 ------------
 468 % git config section.key value '[!]'
 469 ------------
 470
 471 To add a new proxy, without altering any of the existing ones, use
 472
 473 ------------
 474 % git config --add core.gitproxy '"proxy-command" for example.com'
 475 ------------
 476
 477 An example to use customized color from the configuration in your
 478 script:
 479
 480 ------------
 481 #!/bin/sh
 482 WS=$(git config --get-color color.diff.whitespace "blue reverse")
 483 RESET=$(git config --get-color "" "reset")
 484 echo "${WS}your whitespace color or blue reverse${RESET}"
 485 ------------
 486
 487 For URLs in `https://weak.example.com`, `http.sslVerify` is set to
 488 false, while it is set to `true` for all others:
 489
 490 ------------
 491 % git config --type=bool --get-urlmatch http.sslverify https://good.example.com
 492 true
 493 % git config --type=bool --get-urlmatch http.sslverify https://weak.example.com
 494 false
 495 % git config --get-urlmatch http https://weak.example.com
 496 http.cookieFile /tmp/cookie.txt
 497 http.sslverify false
 498 ------------
 499
 500 include::config.txt[]
 501
 502 BUGS
 503 ----
 504 When using the deprecated `[section.subsection]` syntax, changing a value
 505 will result in adding a multi-line key instead of a change, if the subsection
 506 is given with at least one uppercase character. For example when the config
 507 looks like
 508
 509 --------
 510   [section.subsection]
 511     key = value1
 512 --------
 513
 514 and running `git config section.Subsection.key value2` will result in
 515
 516 --------
 517   [section.subsection]
 518     key = value1
 519     key = value2
 520 --------
 521
 522
 523 GIT
 524 ---
 525 Part of the linkgit:git[1] suite