Setup and Config
Getting and Creating Projects
Basic Snapshotting
Branching and Merging
Sharing and Updating Projects
Inspection and Comparison
Patching
Debugging
External Systems
Server Admin
Guides
- gitattributes
- Command-line interface conventions
- Everyday Git
- Frequently Asked Questions (FAQ)
- Glossary
- Hooks
- gitignore
- gitmodules
- Revisions
- Submodules
- Tutorial
- Workflows
- All guides...
Administration
Plumbing Commands
-
2.52.0
2025-11-17
-
2.51.2
2025-10-27
-
2.51.1
2025-10-15
-
2.51.0
2025-08-18
- 2.50.1 no changes
-
2.50.0
2025-06-16
- 2.49.1 no changes
-
2.49.0
2025-03-14
- 2.48.2 no changes
-
2.48.1
2025-01-13
-
2.48.0
2025-01-10
- 2.47.3 no changes
-
2.47.2
2024-11-26
-
2.47.1
2024-11-25
-
2.47.0
2024-10-06
- 2.46.4 no changes
-
2.46.3
2024-11-26
-
2.46.2
2024-09-23
-
2.46.1
2024-09-13
-
2.46.0
2024-07-29
- 2.45.4 no changes
-
2.45.3
2024-11-26
- 2.45.1 → 2.45.2 no changes
-
2.45.0
2024-04-29
- 2.44.4 no changes
-
2.44.3
2024-11-26
- 2.44.1 → 2.44.2 no changes
-
2.44.0
2024-02-23
- 2.43.7 no changes
-
2.43.6
2024-11-26
- 2.43.2 → 2.43.5 no changes
-
2.43.1
2024-02-09
-
2.43.0
2023-11-20
-
2.42.4
2024-11-26
- 2.42.2 → 2.42.3 no changes
-
2.42.1
2023-11-02
-
2.42.0
2023-08-21
-
2.41.3
2024-11-26
- 2.41.1 → 2.41.2 no changes
-
2.41.0
2023-06-01
-
2.40.4
2024-11-26
- 2.40.1 → 2.40.3 no changes
-
2.40.0
2023-03-12
- 2.39.1 → 2.39.5 no changes
-
2.39.0
2022-12-12
- 2.38.3 → 2.38.5 no changes
-
2.38.2
2022-12-11
-
2.38.1
2022-10-07
-
2.38.0
2022-10-02
- 2.37.5 → 2.37.7 no changes
-
2.37.4
2022-10-06
- 2.37.3 no changes
-
2.37.2
2022-08-11
- 2.37.1 no changes
-
2.37.0
2022-06-27
- 2.36.4 → 2.36.6 no changes
-
2.36.3
2022-10-06
-
2.36.2
2022-06-23
- 2.36.1 no changes
-
2.36.0
2022-04-18
- 2.35.6 → 2.35.8 no changes
-
2.35.5
2022-10-06
-
2.35.4
2022-06-23
-
2.35.3
2022-04-13
-
2.35.2
2022-03-23
- 2.35.1 no changes
-
2.35.0
2022-01-24
- 2.34.6 → 2.34.8 no changes
-
2.34.5
2022-10-06
-
2.34.4
2022-06-23
-
2.34.3
2022-04-13
-
2.34.2
2022-03-23
- 2.34.1 no changes
-
2.34.0
2021-11-15
- 2.33.6 → 2.33.8 no changes
-
2.33.5
2022-10-06
-
2.33.4
2022-06-23
-
2.33.3
2022-04-13
-
2.33.2
2022-03-23
-
2.33.1
2021-10-12
-
2.33.0
2021-08-16
- 2.32.5 → 2.32.7 no changes
-
2.32.4
2022-10-06
-
2.32.3
2022-06-23
-
2.32.2
2022-04-13
-
2.32.1
2022-03-23
-
2.32.0
2021-06-06
- 2.31.6 → 2.31.8 no changes
-
2.31.5
2022-10-06
-
2.31.4
2022-06-23
-
2.31.3
2022-04-13
-
2.31.2
2022-03-23
-
2.31.1
2021-03-26
-
2.31.0
2021-03-15
- 2.30.7 → 2.30.9 no changes
-
2.30.6
2022-10-06
-
2.30.5
2022-06-23
-
2.30.4
2022-04-13
-
2.30.3
2022-03-23
- 2.30.2 no changes
-
2.30.1
2021-02-08
-
2.30.0
2020-12-27
- 2.29.1 → 2.29.3 no changes
-
2.29.0
2020-10-19
- 2.28.1 no changes
-
2.28.0
2020-07-27
- 2.27.1 no changes
-
2.27.0
2020-06-01
- 2.26.1 → 2.26.3 no changes
-
2.26.0
2020-03-22
- 2.25.3 → 2.25.5 no changes
-
2.25.2
2020-03-17
-
2.25.1
2020-02-17
-
2.25.0
2020-01-13
- 2.24.1 → 2.24.4 no changes
-
2.24.0
2019-11-04
- 2.23.1 → 2.23.4 no changes
-
2.23.0
2019-08-16
- 2.22.2 → 2.22.5 no changes
-
2.22.1
2019-08-11
-
2.22.0
2019-06-07
- 2.21.1 → 2.21.4 no changes
-
2.21.0
2019-02-24
- 2.20.1 → 2.20.5 no changes
-
2.20.0
2018-12-09
- 2.19.3 → 2.19.6 no changes
-
2.19.2
2018-11-21
- 2.19.1 no changes
-
2.19.0
2018-09-10
- 2.18.1 → 2.18.5 no changes
-
2.18.0
2018-06-21
- 2.17.1 → 2.17.6 no changes
-
2.17.0
2018-04-02
-
2.16.6
2019-12-06
-
2.15.4
2019-12-06
-
2.14.6
2019-12-06
-
2.13.7
2018-05-22
-
2.12.5
2017-09-22
-
2.11.4
2017-09-22
-
2.10.5
2017-09-22
-
2.9.5
2017-07-30
-
2.8.6
2017-07-30
-
2.7.6
2017-07-30
-
2.6.7
2017-05-05
-
2.5.6
2017-05-05
-
2.4.12
2017-05-05
-
2.3.10
2015-09-28
-
2.2.3
2015-09-04
-
2.1.4
2014-12-17
-
2.0.5
2014-12-17
SYNOPSIS
git config list [<file-option>] [<display-option>] [--includes] git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp] [--value=<pattern>] [--fixed-value] [--default=<default>] [--url=<url>] <name> git config set [<file-option>] [--type=<type>] [--all] [--value=<pattern>] [--fixed-value] <name> <value> git config unset [<file-option>] [--all] [--value=<pattern>] [--fixed-value] <name> git config rename-section [<file-option>] <old-name> <new-name> git config remove-section [<file-option>] <name> git config edit [<file-option>] git config [<file-option>] --get-colorbool <name> [<stdout-is-tty>]
DESCRIPTION
You can query/set/replace/unset options with this command. The name is actually the section and the key separated by a dot, and the value will be escaped.
Multiple lines can be added to an option by using the --append option.
If you want to update or unset an option which can occur on multiple
lines, --value=<pattern> (which is an extended regular expression,
unless the --fixed-value option is given) needs to be given. Only the
existing values that match the pattern are updated or unset. If
you want to handle the lines that do not match the pattern, just
prepend a single exclamation mark in front (see also EXAMPLES),
but note that this only works when the --fixed-value option is not
in use.
The --type=<type> option instructs git config to ensure that incoming and
outgoing values are canonicalize-able under the given <type>. If no
--type=<type> is given, no canonicalization will be performed. Callers may
unset an existing --type specifier with --no-type.
When reading, the values are read from the system, global and
repository local configuration files by default, and options
--system, --global, --local, --worktree and
--file <filename> can be used to tell the command to read from only
that location (see FILES).
When writing, the new value is written to the repository local
configuration file by default, and options --system, --global,
--worktree, --file <filename> can be used to tell the command to
write to that location (you can say --local but that is the
default).
This command will fail with non-zero status upon error. Some exit codes are:
-
The section or key is invalid (ret=1),
-
no section or name was provided (ret=2),
-
the config file is invalid (ret=3),
-
the config file cannot be written (ret=4),
-
you try to unset an option which does not exist (ret=5),
-
you try to unset/set an option for which multiple lines match (ret=5), or
-
you try to use an invalid regexp (ret=6).
On success, the command returns the exit code 0.
A list of all available configuration variables can be obtained using the
git help --config command.
COMMANDS
- list
-
List all variables set in config file, along with their values.
- get
-
Emits the value of the specified key. If key is present multiple times in the configuration, emits the last value. If
--allis specified, emits all values associated with key. Returns error code 1 if key is not present. - set
-
Set value for one or more config options. By default, this command refuses to write multi-valued config options. Passing
--allwill replace all multi-valued config options with the new value, whereas--value=will replace all config options whose values match the given pattern. - unset
-
Unset value for one or more config options. By default, this command refuses to unset multi-valued keys. Passing
--allwill unset all multi-valued config options, whereas--valuewill unset all config options whose values match the given pattern. - rename-section
-
Rename the given section to a new name.
- remove-section
-
Remove the given section from the configuration file.
- edit
-
Opens an editor to modify the specified config file; either
--system,--global,--local(default),--worktree, or--file<config-file>.
OPTIONS
- --replace-all
-
Default behavior is to replace at most one line. This replaces all lines matching the key (and optionally
--value=<pattern>). - --append
-
Adds a new line to the option without altering any existing values. This is the same as providing --value=^$ in
set. - --comment <message>
-
Append a comment at the end of new or modified lines.
If <message> begins with one or more whitespaces followed by "", it is used as-is. If it begins with "", a space is prepended before it is used. Otherwise, a string " # " (a space followed by a hash followed by a space) is prepended to it. And the resulting string is placed immediately after the value defined for the variable. The <message> must not contain linefeed characters (no multi-line comments are permitted).
- --all
-
With
get, return all values for a multi-valued key. - --regexp
-
With
get, interpret the name as a regular expression. Regular expression matching is currently case-sensitive and done against a canonicalized version of the key in which section and variable names are lowercased, but subsection names are not. - --url=<URL>
-
When given a two-part <name> as <section>.<key>, the value for <section>.<URL>.<key> whose <URL> part matches the best to the given URL is returned (if no such key exists, the value for <section>.<key> is used as a fallback). When given just the <section> as name, do so for all the keys in the section and list them. Returns error code 1 if no value is found.
- --global
-
For writing options: write to global
~/.gitconfigfile rather than the repository.git/config, write to$XDG_CONFIG_HOME/git/configfile if this file exists and the~/.gitconfigfile doesn’t.For reading options: read only from global
~/.gitconfigand from$XDG_CONFIG_HOME/git/configrather than from all available files.See also FILES.
- --system
-
For writing options: write to system-wide
$(prefix)/etc/gitconfigrather than the repository.git/config.For reading options: read only from system-wide
$(prefix)/etc/gitconfigrather than from all available files.See also FILES.
- --local
-
For writing options: write to the repository
.git/configfile. This is the default behavior.For reading options: read only from the repository
.git/configrather than from all available files.See also FILES.
- --worktree
-
Similar to
--localexcept that$GIT_DIR/config.worktreeis read from or written to ifextensions.worktreeConfigis enabled. If not it’s the same as--local. Note that$GIT_DIRis equal to$GIT_COMMON_DIRfor the main working tree, but is of the form$GIT_DIR/worktrees/<id>/for other working trees. See git-worktree[1] to learn how to enableextensions.worktreeConfig. - -f <config-file>
- --file <config-file>
-
For writing options: write to the specified file rather than the repository
.git/config.For reading options: read only from the specified file rather than from all available files.
See also FILES.
- --blob <blob>
-
Similar to
--filebut use the given blob instead of a file. E.g. you can use master:.gitmodules to read values from the file .gitmodules in the master branch. See "SPECIFYING REVISIONS" section in gitrevisions[7] for a more complete list of ways to spell blob names. --value=<pattern>--no-value-
With
get,set, andunset, match only against <pattern>. The pattern is an extended regular expression unless--fixed-valueis given.Use
--no-valueto unset <pattern>. - --fixed-value
-
When used with
--value=<pattern>, treat <pattern> as an exact string instead of a regular expression. This will restrict the name/value pairs that are matched to only those where the value is exactly equal to <pattern>. - --type <type>
-
git config will ensure that any input or output is valid under the given type constraint(s), and will canonicalize outgoing values in <type>'s canonical form.
Valid <type>'s include:
-
bool: canonicalize values
true,yes,on, and positive numbers as "true", and valuesfalse,no,offand0as "false". -
int: canonicalize values as simple decimal numbers. An optional suffix of k, m, or g will cause the value to be multiplied by 1024, 1048576, or 1073741824 upon input.
-
bool-or-int: canonicalize according to either bool or int, as described above.
-
path: canonicalize by expanding a leading
~to the value of$HOMEand~userto the home directory for the specified user. This specifier has no effect when setting the value (but you can usegitconfigsection.variable~/from the command line to let your shell do the expansion.) -
expiry-date: canonicalize by converting from a fixed or relative date-string to a timestamp. This specifier has no effect when setting the value.
-
color: When getting a value, canonicalize by converting to an ANSI color escape sequence. When setting a value, a sanity-check is performed to ensure that the given value is canonicalize-able as an ANSI color, but it is written as-is.
-
- --bool
- --int
- --bool-or-int
- --path
- --expiry-date
-
Historical options for selecting a type specifier. Prefer instead
--type(see above). - --no-type
-
Un-sets the previously set type specifier (if one was previously set). This option requests that git config not canonicalize the retrieved variable.
--no-typehas no effect without--type=<type> or--<type>. - -z
- --null
-
For all options that output values and/or keys, always end values with the null character (instead of a newline). Use newline instead as a delimiter between key and value. This allows for secure parsing of the output without getting confused e.g. by values that contain line breaks.
- --name-only
-
Output only the names of config variables for
listorget. --show-names--no-show-names-
With
get, show config keys in addition to their values. The default is--no-show-namesunless--urlis given and there are no subsections in <name>. - --show-origin
-
Augment the output of all queried config options with the origin type (file, standard input, blob, command line) and the actual origin (config file path, ref, or blob id if applicable).
- --show-scope
-
Similar to
--show-originin that it augments the output of all queried config options with the scope of that value (worktree, local, global, system, command). - --get-colorbool <name> [<stdout-is-tty>]
-
Find the color setting for <name> (e.g.
color.diff) and output "true" or "false". <stdout-is-tty> should be either "true" or "false", and is taken into account when configuration says "auto". If <stdout-is-tty> is missing, then checks the standard output of the command itself, and exits with status 0 if color is to be used, or exits with status 1 otherwise. When the color setting fornameis undefined, the command usescolor.uias fallback. - --includes
- --no-includes
-
Respect
include.*directives in config files when looking up values. Defaults tooffwhen a specific file is given (e.g., using--file,--global, etc) andonwhen searching all config files. - --default <value>
-
When using
get, and the requested variable is not found, behave as if <value> were the value assigned to that variable.
DEPRECATED MODES
The following modes have been deprecated in favor of subcommands. It is recommended to migrate to the new syntax.
- git config <name>
-
Replaced by
gitconfigget<name>. - git config <name> <value> [<value-pattern>]
-
Replaced by
gitconfigset[--value=<pattern>] <name> <value>. - -l
- --list
-
Replaced by
gitconfiglist. - --get <name> [<value-pattern>]
-
Replaced by
gitconfigget[--value=<pattern>] <name>. - --get-all <name> [<value-pattern>]
-
Replaced by
gitconfigget[--value=<pattern>]--all<name>. - --get-regexp <name-regexp>
-
Replaced by
gitconfigget--all--show-names--regexp<name-regexp>. - --get-urlmatch <name> <URL>
-
Replaced by
gitconfigget--all--show-names--url=<URL> <name>. - --get-color <name> [<default>]
-
Replaced by
gitconfigget--type=color[--default=<default>] <name>. - --add <name> <value>
-
Replaced by
gitconfigset--append<name> <value>. - --unset <name> [<value-pattern>]
-
Replaced by
gitconfigunset[--value=<pattern>] <name>. - --unset-all <name> [<value-pattern>]
-
Replaced by
gitconfigunset[--value=<pattern>]--all<name>. - --rename-section <old-name> <new-name>
-
Replaced by
gitconfigrename-section<old-name> <new-name>. - --remove-section <name>
-
Replaced by
gitconfigremove-section<name>. - -e
- --edit
-
Replaced by
gitconfigedit.
CONFIGURATION
pager.config is only respected when listing configuration, i.e., when
using list or get which may return multiple results. The default is to use
a pager.
FILES
By default, git config will read configuration options from multiple files:
- $(prefix)/etc/gitconfig
-
System-wide configuration file.
- $XDG_CONFIG_HOME/git/config
- ~/.gitconfig
-
User-specific configuration files. When the XDG_CONFIG_HOME environment variable is not set or empty, $HOME/.config/ is used as $XDG_CONFIG_HOME.
These are also called "global" configuration files. If both files exist, both files are read in the order given above.
- $GIT_DIR/config
-
Repository specific configuration file.
- $GIT_DIR/config.worktree
-
This is optional and is only searched when
extensions.worktreeConfigis present in $GIT_DIR/config.
You may also provide additional configuration parameters when running any
git command by using the -c option. See git[1] for details.
Options will be read from all of these files that are available. If the global or the system-wide configuration files are missing or unreadable they will be ignored. If the repository configuration file is missing or unreadable, git config will exit with a non-zero error code. An error message is produced if the file is unreadable, but not if it is missing.
The files are read in the order given above, with last value found taking precedence over values read earlier. When multiple values are taken then all values of a key from all files will be used.
By default, options are only written to the repository specific
configuration file. Note that this also affects options like set
and unset. git config will only ever change one file at a time.
You can limit which configuration sources are read from or written to by
specifying the path of a file with the --file option, or by specifying a
configuration scope with --system, --global, --local, or --worktree.
For more, see OPTIONS above.
SCOPES
Each configuration source falls within a configuration scope. The scopes are:
- system
-
$(prefix)/etc/gitconfig
- global
-
$XDG_CONFIG_HOME/git/config
~/.gitconfig
- local
-
$GIT_DIR/config
- worktree
-
$GIT_DIR/config.worktree
- command
-
GIT_CONFIG_{COUNT,KEY,VALUE} environment variables (see ENVIRONMENT below)
the
-coption
With the exception of command, each scope corresponds to a command line
option: --system, --global, --local, --worktree.
When reading options, specifying a scope will only read options from the files within that scope. When writing options, specifying a scope will write to the files within that scope (instead of the repository specific configuration file). See OPTIONS above for a complete description.
Most configuration options are respected regardless of the scope it is defined in, but some options are only respected in certain scopes. See the respective option’s documentation for the full details.
Protected configuration
Protected configuration refers to the system, global, and command scopes. For security reasons, certain options are only respected when they are specified in protected configuration, and ignored otherwise.
Git treats these scopes as if they are controlled by the user or a trusted administrator. This is because an attacker who controls these scopes can do substantial harm without using Git, so it is assumed that the user’s environment protects these scopes against attackers.
ENVIRONMENT
See also FILES.
- GIT_CONFIG_COUNT
- GIT_CONFIG_KEY_<n>
- GIT_CONFIG_VALUE_<n>
-
If GIT_CONFIG_COUNT is set to a positive number, all environment pairs GIT_CONFIG_KEY_<n> and GIT_CONFIG_VALUE_<n> up to that number will be added to the process’s runtime configuration. The config pairs are zero-indexed. Any missing key or value is treated as an error. An empty GIT_CONFIG_COUNT is treated the same as GIT_CONFIG_COUNT=0, namely no pairs are processed. These environment variables will override values in configuration files, but will be overridden by any explicit options passed via
git-c.This is useful for cases where you want to spawn multiple git commands with a common configuration but cannot depend on a configuration file, for example when writing scripts.
- GIT_CONFIG
-
If no
--fileoption is provided togitconfig, use the file given byGIT_CONFIGas if it were provided via--file. This variable has no effect on other Git commands, and is mostly for historical compatibility; there is generally no reason to use it instead of the--fileoption.
EXAMPLES
Given a .git/config like this:
# # This is the config file, and # a '#' or ';' character indicates # a comment # ; core variables [core] ; Don't trust file modes filemode = false ; Our diff algorithm [diff] external = /usr/local/bin/diff-wrapper renames = true ; Proxy settings [core] gitproxy=proxy-command for kernel.org gitproxy=default-proxy ; for all the rest ; HTTP [http] sslVerify [http "https://weak.example.com"] sslVerify = false cookieFile = /tmp/cookie.txt
you can set the filemode to true with
% git config set core.filemode true
The hypothetical proxy command entries actually have a postfix to discern what URL they apply to. Here is how to change the entry for kernel.org to "ssh".
% git config set --value='for kernel.org$' core.gitproxy '"ssh" for kernel.org'
This makes sure that only the key/value pair for kernel.org is replaced.
To delete the entry for renames, do
% git config unset diff.renames
If you want to delete an entry for a multivar (like core.gitproxy above), you have to provide a regex matching the value of exactly one line.
To query the value for a given key, do
% git config get core.filemode
or, to query a multivar:
% git config get --value="for kernel.org$" core.gitproxy
If you want to know all the values for a multivar, do:
% git config get --all --show-names core.gitproxy
If you like to live dangerously, you can replace all core.gitproxy by a new one with
% git config set --all core.gitproxy ssh
However, if you really only want to replace the line for the default proxy, i.e. the one without a "for …" postfix, do something like this:
% git config set --value='! for ' core.gitproxy ssh
To actually match only values with an exclamation mark, you have to
% git config set --value='[!]' section.key value
To add a new proxy, without altering any of the existing ones, use
% git config set --append core.gitproxy '"proxy-command" for example.com'
An example to use customized color from the configuration in your script:
#!/bin/sh
WS=$(git config get --type=color --default="blue reverse" color.diff.whitespace)
RESET=$(git config get --type=color --default="reset" "")
echo "${WS}your whitespace color or blue reverse${RESET}"
For URLs in https://weak.example.com, http.sslVerify is set to
false, while it is set to true for all others:
% git config get --type=bool --url=https://good.example.com http.sslverify true % git config get --type=bool --url=https://weak.example.com http.sslverify false % git config get --url=https://weak.example.com http http.cookieFile /tmp/cookie.txt http.sslverify false
CONFIGURATION FILE
The Git configuration file contains a number of variables that affect
the Git commands' behavior. The files .git/config and optionally
config.worktree (see the "CONFIGURATION FILE" section of
git-worktree[1]) in each repository are used to store the
configuration for that repository, and $HOME/.gitconfig is used to
store a per-user configuration as fallback values for the .git/config
file. The file /etc/gitconfig can be used to store a system-wide
default configuration.
The configuration variables are used by both the Git plumbing
and the porcelain commands. The variables are divided into sections, wherein
the fully qualified variable name of the variable itself is the last
dot-separated segment and the section name is everything before the last
dot. The variable names are case-insensitive, allow only alphanumeric
characters and -, and must start with an alphabetic character. Some
variables may appear multiple times; we say then that the variable is
multivalued.
Syntax
The syntax is fairly flexible and permissive. Whitespace characters, which in this context are the space character (SP) and the horizontal tabulation (HT), are mostly ignored. The # and ; characters begin comments to the end of line. Blank lines are ignored.
The file consists of sections and variables. A section begins with
the name of the section in square brackets and continues until the next
section begins. Section names are case-insensitive. Only alphanumeric
characters, - and . are allowed in section names. Each variable
must belong to some section, which means that there must be a section
header before the first setting of a variable.
Sections can be further divided into subsections. To begin a subsection put its name in double quotes, separated by space from the section name, in the section header, like in the example below:
[section "subsection"]
Subsection names are case sensitive and can contain any characters except
newline and the null byte. Doublequote " and backslash can be included
by escaping them as \" and \\, respectively. Backslashes preceding
other characters are dropped when reading; for example, \t is read as
t and \0 is read as 0. Section headers cannot span multiple lines.
Variables may belong directly to a section or to a given subsection. You
can have [section] if you have [section "subsection"], but you don’t
need to.
There is also a deprecated [section.subsection] syntax. With this
syntax, the subsection name is converted to lower-case and is also
compared case sensitively. These subsection names follow the same
restrictions as section names.
All the other lines (and the remainder of the line after the section
header) are recognized as setting variables, in the form
name = value (or just name, which is a short-hand to say that
the variable is the boolean "true").
The variable names are case-insensitive, allow only alphanumeric characters
and -, and must start with an alphabetic character.
Whitespace characters surrounding name, = and value are discarded.
Internal whitespace characters within value are retained verbatim.
Comments starting with either # or ; and extending to the end of line
are discarded. A line that defines a value can be continued to the next
line by ending it with a backslash (\); the backslash and the end-of-line
characters are discarded.
If value needs to contain leading or trailing whitespace characters,
it must be enclosed in double quotation marks ("). Inside double quotation
marks, double quote (") and backslash (\) characters must be escaped:
use \" for " and \\ for \.
The following escape sequences (beside \" and \\) are recognized: \n for newline character (NL), \t for horizontal tabulation (HT, TAB) and \b for backspace (BS). Other char escape sequences (including octal escape sequences) are invalid.
Includes
The include and includeIf sections allow you to include config
directives from another source. These sections behave identically to
each other with the exception that includeIf sections may be ignored
if their condition does not evaluate to true; see "Conditional includes"
below.
You can include a config file from another by setting the special
include.path (or includeIf.*.path) variable to the name of the file
to be included. The variable takes a pathname as its value, and is
subject to tilde expansion. These variables can be given multiple times.
The contents of the included file are inserted immediately, as if they had been found at the location of the include directive. If the value of the variable is a relative path, the path is considered to be relative to the configuration file in which the include directive was found. See below for examples.
Conditional includes
You can conditionally include a config file from another by setting an
includeIf.<condition>.path variable to the name of the file to be
included.
The condition starts with a keyword followed by a colon and some data whose format and meaning depends on the keyword. Supported keywords are:
gitdir-
The data that follows the keyword
gitdirand a colon is used as a glob pattern. If the location of the .git directory matches the pattern, the include condition is met.The .git location may be auto-discovered, or come from
$GIT_DIRenvironment variable. If the repository is auto-discovered via a .git file (e.g. from submodules, or a linked worktree), the .git location would be the final location where the .git directory is, not where the .git file is.The pattern can contain standard globbing wildcards and two additional ones,
**/and/**, that can match multiple path components. Please refer to gitignore[5] for details. For convenience:-
If the pattern starts with
~/,~will be substituted with the content of the environment variableHOME. -
If the pattern starts with
./, it is replaced with the directory containing the current config file. -
If the pattern does not start with either
~/,./or/,**/will be automatically prepended. For example, the patternfoo/barbecomes**/foo/barand would match/any/path/to/foo/bar. -
If the pattern ends with
/,**will be automatically added. For example, the patternfoo/becomesfoo/**. In other words, it matches "foo" and everything inside, recursively.
-
gitdir/i-
This is the same as
gitdirexcept that matching is done case-insensitively (e.g. on case-insensitive file systems) onbranch-
The data that follows the keyword
onbranchand a colon is taken to be a pattern with standard globbing wildcards and two additional ones,**/and/**, that can match multiple path components. If we are in a worktree where the name of the branch that is currently checked out matches the pattern, the include condition is met.If the pattern ends with
/,**will be automatically added. For example, the patternfoo/becomesfoo/**. In other words, it matches all branches that begin withfoo/. This is useful if your branches are organized hierarchically and you would like to apply a configuration to all the branches in that hierarchy. hasconfig:remote.*.url-
The data that follows this keyword and a colon is taken to be a pattern with standard globbing wildcards and two additional ones,
**/and/**, that can match multiple components. The first time this keyword is seen, the rest of the config files will be scanned for remote URLs (without applying any values). If there exists at least one remote URL that matches this pattern, the include condition is met.Files included by this option (directly or indirectly) are not allowed to contain remote URLs.
Note that unlike other includeIf conditions, resolving this condition relies on information that is not yet known at the point of reading the condition. A typical use case is this option being present as a system-level or global-level config, and the remote URL being in a local-level config; hence the need to scan ahead when resolving this condition. In order to avoid the chicken-and-egg problem in which potentially-included files can affect whether such files are potentially included, Git breaks the cycle by prohibiting these files from affecting the resolution of these conditions (thus, prohibiting them from declaring remote URLs).
As for the naming of this keyword, it is for forwards compatibility with a naming scheme that supports more variable-based include conditions, but currently Git only supports the exact keyword described above.
A few more notes on matching via gitdir and gitdir/i:
-
Symlinks in
$GIT_DIRare not resolved before matching. -
Both the symlink & realpath versions of paths will be matched outside of
$GIT_DIR. E.g. if ~/git is a symlink to /mnt/storage/git, bothgitdir:~/gitandgitdir:/mnt/storage/gitwill match.This was not the case in the initial release of this feature in v2.13.0, which only matched the realpath version. Configuration that wants to be compatible with the initial release of this feature needs to either specify only the realpath version, or both versions.
-
Note that "../" is not special and will match literally, which is unlikely what you want.
Example
# Core variables [core] ; Don't trust file modes filemode = false # Our diff algorithm [diff] external = /usr/local/bin/diff-wrapper renames = true [branch "devel"] remote = origin merge = refs/heads/devel # Proxy settings [core] gitProxy="ssh" for "kernel.org" gitProxy=default-proxy ; for the rest [include] path = /path/to/foo.inc ; include by absolute path path = foo.inc ; find "foo.inc" relative to the current file path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory ; include if $GIT_DIR is /path/to/foo/.git [includeIf "gitdir:/path/to/foo/.git"] path = /path/to/foo.inc ; include for all repositories inside /path/to/group [includeIf "gitdir:/path/to/group/"] path = /path/to/foo.inc ; include for all repositories inside $HOME/to/group [includeIf "gitdir:~/to/group/"] path = /path/to/foo.inc ; relative paths are always relative to the including ; file (if the condition is true); their location is not ; affected by the condition [includeIf "gitdir:/path/to/group/"] path = foo.inc ; include only if we are in a worktree where foo-branch is ; currently checked out [includeIf "onbranch:foo-branch"] path = foo.inc ; include only if a remote with the given URL exists (note ; that such a URL may be provided later in a file or in a ; file read after this file is read, as seen in this example) [includeIf "hasconfig:remote.*.url:https://example.com/**"] path = foo.inc [remote "origin"] url = https://example.com/git
Values
Values of many variables are treated as a simple string, but there are variables that take values of specific types and there are rules as to how to spell them.
- boolean
-
When a variable is said to take a boolean value, many synonyms are accepted for true and false; these are all case-insensitive.
- true
-
Boolean true literals are
yes,on,true, and1. Also, a variable defined without=<value> is taken as true. - false
-
Boolean false literals are
no,off,false,0and the empty string.When converting a value to its canonical form using the
--type=booltype specifier, git config will ensure that the output is "true" or "false" (spelled in lowercase).
- integer
-
The value for many variables that specify various sizes can be suffixed with
k,M,… to mean "scale the number by 1024", "by 1024x1024", etc. - color
-
The value for a variable that takes a color is a list of colors (at most two, one for foreground and one for background) and attributes (as many as you want), separated by spaces.
The basic colors accepted are
normal,black,red,green,yellow,blue,magenta,cyan,whiteanddefault. The first color given is the foreground; the second is the background. All the basic colors exceptnormalanddefaulthave a bright variant that can be specified by prefixing the color withbright, likebrightred.The color
normalmakes no change to the color. It is the same as an empty string, but can be used as the foreground color when specifying a background color alone (for example, "normal red").The color
defaultexplicitly resets the color to the terminal default, for example to specify a cleared background. Although it varies between terminals, this is usually not the same as setting to "white black".Colors may also be given as numbers between 0 and 255; these use ANSI 256-color mode (but note that not all terminals may support this). If your terminal supports it, you may also specify 24-bit RGB values as hex, like
#ff0ab3, or 12-bit RGB values like#f1b, which is equivalent to the 24-bit color#ff11bb.The accepted attributes are
bold,dim,ul,blink,reverse,italic, andstrike(for crossed-out or "strikethrough" letters). The position of any attributes with respect to the colors (before, after, or in between), doesn’t matter. Specific attributes may be turned off by prefixing them withnoorno-(e.g.,noreverse,no-ul, etc).The pseudo-attribute
resetresets all colors and attributes before applying the specified coloring. For example,resetgreenwill result in a green foreground and default background without any active attributes.An empty color string produces no color effect at all. This can be used to avoid coloring specific elements without disabling color entirely.
For git’s pre-defined color slots, the attributes are meant to be reset at the beginning of each item in the colored output. So setting
color.decorate.branchtoblackwill paint that branch name in a plainblack, even if the previous thing on the same output line (e.g. opening parenthesis before the list of branch names inlog--decorateoutput) is set to be painted withboldor some other attribute. However, custom log formats may do more complicated and layered coloring, and the negated forms may be useful there. - pathname
-
A variable that takes a pathname value can be given a string that begins with "
~/" or "~user/", and the usual tilde expansion happens to such a string:~/is expanded to the value of$HOME, and~user/to the specified user’s home directory.If a path starts with
%(prefix)/, the remainder is interpreted as a path relative to Git’s "runtime prefix", i.e. relative to the location where Git itself was installed. For example,%(prefix)/bin/refers to the directory in which the Git executable itself lives. If Git was compiled without runtime prefix support, the compiled-in prefix will be substituted instead. In the unlikely event that a literal path needs to be specified that should not be expanded, it needs to be prefixed by./, like so:./%(prefix)/bin.If prefixed with
:(optional), the configuration variable is treated as if it does not exist, if the named path does not exist.
Variables
Note that this list is non-comprehensive and not necessarily complete. For command-specific variables, you will find a more detailed description in the appropriate manual page.
Other git-related tools may and do use their own variables. When inventing new variables for use in your own tool, make sure their names do not conflict with those that are used by Git itself and other popular tools, and describe them in your documentation.
add.ignoreErrorsadd.ignore-errors(deprecated)-
Tells
gitaddto continue adding files when some files cannot be added due to indexing errors. Equivalent to the--ignore-errorsoption of git-add[1].add.ignore-errorsis deprecated, as it does not follow the usual naming convention for configuration variables. - advice.*
-
These variables control various optional help messages designed to aid new users. When left unconfigured, Git will give the message alongside instructions on how to squelch it. You can tell Git that you have understood the issue and no longer need a specific help message by setting the corresponding variable to
false.As they are intended to help human users, these messages are output to the standard error. When tools that run Git as a subprocess find them disruptive, they can set
GIT_ADVICE=0in the environment to squelch all advice messages.- addEmbeddedRepo
-
Shown when the user accidentally adds one git repo inside of another.
- addEmptyPathspec
-
Shown when the user runs
gitaddwithout providing the pathspec parameter. - addIgnoredFile
-
Shown when the user attempts to add an ignored file to the index.
- amWorkDir
-
Shown when git-am[1] fails to apply a patch file, to tell the user the location of the file.
- ambiguousFetchRefspec
-
Shown when a fetch refspec for multiple remotes maps to the same remote-tracking branch namespace and causes branch tracking set-up to fail.
- checkoutAmbiguousRemoteBranchName
-
Shown when the argument to git-checkout[1] and git-switch[1] ambiguously resolves to a remote tracking branch on more than one remote in situations where an unambiguous argument would have otherwise caused a remote-tracking branch to be checked out. See the
checkout.defaultRemoteconfiguration variable for how to set a given remote to be used by default in some situations where this advice would be printed. - commitBeforeMerge
-
Shown when git-merge[1] refuses to merge to avoid overwriting local changes.
- detachedHead
-
Shown when the user uses git-switch[1] or git-checkout[1] to move to the detached HEAD state, to tell the user how to create a local branch after the fact.
- diverging
-
Shown when a fast-forward is not possible.
- fetchShowForcedUpdates
-
Shown when git-fetch[1] takes a long time to calculate forced updates after ref updates, or to warn that the check is disabled.
- forceDeleteBranch
-
Shown when the user tries to delete a not fully merged branch without the force option set.
- ignoredHook
-
Shown when a hook is ignored because the hook is not set as executable.
- implicitIdentity
-
Shown when the user’s information is guessed from the system username and domain name, to tell the user how to set their identity configuration.
- mergeConflict
-
Shown when various commands stop because of conflicts.
- nestedTag
-
Shown when a user attempts to recursively tag a tag object.
- pushAlreadyExists
-
Shown when git-push[1] rejects an update that does not qualify for fast-forwarding (e.g., a tag.)
- pushFetchFirst
-
Shown when git-push[1] rejects an update that tries to overwrite a remote ref that points at an object we do not have.
- pushNeedsForce
-
Shown when git-push[1] rejects an update that tries to overwrite a remote ref that points at an object that is not a commit-ish, or make the remote ref point at an object that is not a commit-ish.
- pushNonFFCurrent
-
Shown when git-push[1] fails due to a non-fast-forward update to the current branch.
- pushNonFFMatching
-
Shown when the user ran git-push[1] and pushed "matching refs" explicitly (i.e. used
:, or specified a refspec that isn’t the current branch) and it resulted in a non-fast-forward error. - pushRefNeedsUpdate
-
Shown when git-push[1] rejects a forced update of a branch when its remote-tracking ref has updates that we do not have locally.
- pushUnqualifiedRefname
-
Shown when git-push[1] gives up trying to guess based on the source and destination refs what remote ref namespace the source belongs in, but where we can still suggest that the user push to either
refs/heads/*orrefs/tags/*based on the type of the source object. - pushUpdateRejected
-
Set this variable to
falseif you want to disablepushNonFFCurrent,pushNonFFMatching,pushAlreadyExists,pushFetchFirst,pushNeedsForce, andpushRefNeedsUpdatesimultaneously. - rebaseTodoError
-
Shown when there is an error after editing the rebase todo list.
- refSyntax
-
Shown when the user provides an illegal ref name, to tell the user about the ref syntax documentation.
- resetNoRefresh
-
Shown when git-reset[1] takes more than 2 seconds to refresh the index after reset, to tell the user that they can use the
--no-refreshoption. - resolveConflict
-
Shown by various commands when conflicts prevent the operation from being performed.
- rmHints
-
Shown on failure in the output of git-rm[1], to give directions on how to proceed from the current state.
- sequencerInUse
-
Shown when a sequencer command is already in progress.
- skippedCherryPicks
-
Shown when git-rebase[1] skips a commit that has already been cherry-picked onto the upstream branch.
- sparseIndexExpanded
-
Shown when a sparse index is expanded to a full index, which is likely due to an unexpected set of files existing outside of the sparse-checkout.
- statusAheadBehind
-
Shown when git-status[1] computes the ahead/behind counts for a local ref compared to its remote tracking ref, and that calculation takes longer than expected. Will not appear if
status.aheadBehindis false or the option--no-ahead-behindis given. - statusHints
-
Show directions on how to proceed from the current state in the output of git-status[1], in the template shown when writing commit messages in git-commit[1], and in the help message shown by git-switch[1] or git-checkout[1] when switching branches.
- statusUoption
-
Shown when git-status[1] takes more than 2 seconds to enumerate untracked files, to tell the user that they can use the
-uoption. - submoduleAlternateErrorStrategyDie
-
Shown when a submodule.alternateErrorStrategy option configured to "die" causes a fatal error.
- submoduleMergeConflict
-
Advice shown when a non-trivial submodule merge conflict is encountered.
- submodulesNotUpdated
-
Shown when a user runs a submodule command that fails because
gitsubmoduleupdate--initwas not run. - suggestDetachingHead
-
Shown when git-switch[1] refuses to detach HEAD without the explicit
--detachoption. - updateSparsePath
-
Shown when either git-add[1] or git-rm[1] is asked to update index entries outside the current sparse checkout.
- waitingForEditor
-
Shown when Git is waiting for editor input. Relevant when e.g. the editor is not launched inside the terminal.
- worktreeAddOrphan
-
Shown when the user tries to create a worktree from an invalid reference, to tell the user how to create a new unborn branch instead.
- alias.*
-
Command aliases for the git[1] command wrapper - e.g. after defining
alias.last=cat-filecommitHEAD, the invocationgitlastis equivalent togitcat-filecommitHEAD. To avoid confusion and troubles with script usage, aliases that hide existing Git commands are ignored except for deprecated commands. Arguments are split by spaces, the usual shell quoting and escaping are supported. A quote pair or a backslash can be used to quote them.Note that the first word of an alias does not necessarily have to be a command. It can be a command-line option that will be passed into the invocation of
git. In particular, this is useful when used with-cto pass in one-time configurations or-pto force pagination. For example,loud-rebase=-ccommit.verbose=truerebasecan be defined such that runninggitloud-rebasewould be equivalent togit-ccommit.verbose=truerebase. Also,ps=-pstatuswould be a helpful alias sincegitpswould paginate the output ofgitstatuswhere the original command does not.If the alias expansion is prefixed with an exclamation point, it will be treated as a shell command. For example, defining
alias.new=!gitk--all--notORIG_HEAD, the invocationgitnewis equivalent to running the shell commandgitk--all--notORIG_HEAD. Note:-
Shell commands will be executed from the top-level directory of a repository, which may not necessarily be the current directory.
-
GIT_PREFIXis set as returned by runninggitrev-parse--show-prefixfrom the original current directory. See git-rev-parse[1]. -
Shell command aliases always receive any extra arguments provided to the Git command-line as positional arguments.
-
Care should be taken if your shell alias is a "one-liner" script with multiple commands (e.g. in a pipeline), references multiple arguments, or is otherwise not able to handle positional arguments added at the end. For example:
alias.cmd="!echo$1|grep$2"called asgitcmd12will be executed as echo $1 | grep $2 1 2, which is not what you want. -
A convenient way to deal with this is to write your script operations in an inline function that is then called with any arguments from the command-line. For example alias.cmd = "!c() { echo $1 | grep $2 ; }; c" will correctly execute the prior example.
-
Setting
GIT_TRACE=1can help you debug the command being run for your alias.
-
-
- am.keepcr
-
If true, git-am will call git-mailsplit for patches in mbox format with parameter
--keep-cr. In this case git-mailsplit will not remove \r from lines ending with \r\n. Can be overridden by giving--no-keep-crfrom the command line. See git-am[1], git-mailsplit[1]. - am.threeWay
-
By default,
gitamwill fail if the patch does not apply cleanly. When set to true, this setting tellsgitamto fall back on 3-way merge if the patch records the identity of blobs it is supposed to apply to and we have those blobs available locally (equivalent to giving the--3wayoption from the command line). Defaults tofalse. See git-am[1]. - apply.ignoreWhitespace
-
When set to change, tells git apply to ignore changes in whitespace, in the same way as the
--ignore-space-changeoption. When set to one of: no, none, never, false, it tells git apply to respect all whitespace differences. See git-apply[1]. - apply.whitespace
-
Tells git apply how to handle whitespace, in the same way as the
--whitespaceoption. See git-apply[1]. - attr.tree
-
A reference to a tree in the repository from which to read attributes, instead of the
.gitattributesfile in the working tree. If the value does not resolve to a valid tree object, an empty tree is used instead. When theGIT_ATTR_SOURCEenvironment variable or--attr-sourcecommand line option are used, this configuration variable has no effect.
|
Note
|
The configuration options in bitmapPseudoMerge.* are considered
EXPERIMENTAL and may be subject to change or be removed entirely in the
future. For more information about the pseudo-merge bitmap feature, see
the "Pseudo-merge bitmaps" section of gitpacking[7].
|
- bitmapPseudoMerge.<name>.pattern
-
Regular expression used to match reference names. Commits pointed to by references matching this pattern (and meeting the below criteria, like
bitmapPseudoMerge.<name>.sampleRateandbitmapPseudoMerge.<name>.threshold) will be considered for inclusion in a pseudo-merge bitmap.Commits are grouped into pseudo-merge groups based on whether or not any reference(s) that point at a given commit match the pattern, which is an extended regular expression.
Within a pseudo-merge group, commits may be further grouped into sub-groups based on the capture groups in the pattern. These sub-groupings are formed from the regular expressions by concatenating any capture groups from the regular expression, with a - dash in between.
For example, if the pattern is
refs/tags/, then all tags (provided they meet the below criteria) will be considered candidates for the same pseudo-merge group. However, if the pattern is insteadrefs/remotes/([0-9])+/tags/, then tags from different remotes will be grouped into separate pseudo-merge groups, based on the remote number. - bitmapPseudoMerge.<name>.decay
-
Determines the rate at which consecutive pseudo-merge bitmap groups decrease in size. Must be non-negative. This parameter can be thought of as
kin the functionf(n)=C*n^-k, wheref(n) is the size of the `n`th group.Setting the decay rate equal to
0will cause all groups to be the same size. Setting the decay rate equal to1will cause thenthgrouptobe1/nthe size of the initial group. Higher values of the decay rate cause consecutive groups to shrink at an increasing rate. The default is1.If all groups are the same size, it is possible that groups containing newer commits will be able to be used less often than earlier groups, since it is more likely that the references pointing at newer commits will be updated more often than a reference pointing at an old commit.
- bitmapPseudoMerge.<name>.sampleRate
-
Determines the proportion of non-bitmapped commits (among reference tips) which are selected for inclusion in an unstable pseudo-merge bitmap. Must be between
0and1(inclusive). The default is1. - bitmapPseudoMerge.<name>.threshold
-
Determines the minimum age of non-bitmapped commits (among reference tips, as above) which are candidates for inclusion in an unstable pseudo-merge bitmap. The default is
1.week.ago. - bitmapPseudoMerge.<name>.maxMerges
-
Determines the maximum number of pseudo-merge commits among which commits may be distributed.
For pseudo-merge groups whose pattern does not contain any capture groups, this setting is applied for all commits matching the regular expression. For patterns that have one or more capture groups, this setting is applied for each distinct capture group.
For example, if your capture group is
refs/tags/, then this setting will distribute all tags into a maximum ofmaxMergespseudo-merge commits. However, if your capture group is, say,refs/remotes/([0-9]+)/tags/, then this setting will be applied to each remote’s set of tags individually.Must be non-negative. The default value is 64.
- bitmapPseudoMerge.<name>.stableThreshold
-
Determines the minimum age of commits (among reference tips, as above, however stable commits are still considered candidates even when they have been covered by a bitmap) which are candidates for a stable a pseudo-merge bitmap. The default is
1.month.ago.Setting this threshold to a smaller value (e.g., 1.week.ago) will cause more stable groups to be generated (which impose a one-time generation cost) but those groups will likely become stale over time. Using a larger value incurs the opposite penalty (fewer stable groups which are more useful).
- bitmapPseudoMerge.<name>.stableSize
-
Determines the size (in number of commits) of a stable psuedo-merge bitmap. The default is
512. - blame.blankBoundary
-
Show blank commit object name for boundary commits in git-blame[1]. This option defaults to false.
- blame.coloring
-
This determines the coloring scheme to be applied to blame output. It can be repeatedLines, highlightRecent, or none which is the default.
- blame.date
-
Specifies the format used to output dates in git-blame[1]. If unset the iso format is used. For supported values, see the discussion of the
--dateoption at git-log[1]. - blame.showEmail
-
Show the author email instead of author name in git-blame[1]. This option defaults to false.
- blame.showRoot
-
Do not treat root commits as boundaries in git-blame[1]. This option defaults to false.
- blame.ignoreRevsFile
-
Ignore revisions listed in the file, one unabbreviated object name per line, in git-blame[1]. Whitespace and comments beginning with
#are ignored. This option may be repeated multiple times. Empty file names will reset the list of ignored revisions. This option will be handled before the command line option--ignore-revs-file. - blame.markUnblamableLines
-
Mark lines that were changed by an ignored revision that we could not attribute to another commit with a * in the output of git-blame[1].
- blame.markIgnoredLines
-
Mark lines that were changed by an ignored revision that we attributed to another commit with a ? in the output of git-blame[1].
branch.autoSetupMerge-
Tells
gitbranch,gitswitchandgitcheckoutto set up new branches so that git-pull[1] will appropriately merge from the starting point branch. Note that even if this option is not set, this behavior can be chosen per-branch using the--trackand--no-trackoptions. This option defaults totrue. The valid settings are:false-
no automatic setup is done
true-
automatic setup is done when the starting point is a remote-tracking branch
always-
automatic setup is done when the starting point is either a local branch or remote-tracking branch
inherit-
if the starting point has a tracking configuration, it is copied to the new branch
simple-
automatic setup is done only when the starting point is a remote-tracking branch and the new branch has the same name as the remote branch.
branch.autoSetupRebase-
When a new branch is created with
gitbranch,gitswitchorgitcheckoutthat tracks another branch, this variable tells Git to set up pull to rebase instead of merge (seebranch.<name>.rebase). The valid settings are:See
branch.autoSetupMergefor details on how to set up a branch to track another branch. This option defaults tonever. branch.sort-
This variable controls the sort ordering of branches when displayed by git-branch[1]. Without the
--sort=<value> option provided, the value of this variable will be used as the default. See git-for-each-ref[1] field names for valid values. branch.<name>.remote-
When on branch <name>, it tells
gitfetchandgitpushwhich remote to fetch from or push to. The remote to push to may be overridden withremote.pushDefault(for all branches). The remote to push to, for the current branch, may be further overridden bybranch.<name>.pushRemote. If no remote is configured, or if you are not on any branch and there is more than one remote defined in the repository, it defaults tooriginfor fetching andremote.pushDefaultfor pushing. Additionally,.(a period) is the current local repository (a dot-repository), seebranch.<name>.merge's final note below. branch.<name>.pushRemote-
When on branch <name>, it overrides
branch.<name>.remotefor pushing. It also overridesremote.pushDefaultfor pushing from branch <name>. When you pull from one place (e.g. your upstream) and push to another place (e.g. your own publishing repository), you would want to setremote.pushDefaultto specify the remote to push to for all branches, and use this option to override it for a specific branch. branch.<name>.merge-
Defines, together with
branch.<name>.remote, the upstream branch for the given branch. It tellsgitfetch/gitpull/gitrebasewhich branch to merge and can also affectgitpush(seepush.default). When in branch <name>, it tellsgitfetchthe default refspec to be marked for merging inFETCH_HEAD. The value is handled like the remote part of a refspec, and must match a ref which is fetched from the remote given bybranch.<name>.remote. The merge information is used bygitpull(which first callsgitfetch) to lookup the default branch for merging. Without this option,gitpulldefaults to merge the first refspec fetched. Specify multiple values to get an octopus merge. If you wish to setupgitpullso that it merges into <name> from another branch in the local repository, you can pointbranch.<name>.mergeto the desired branch, and use the relative path setting.(a period) forbranch.<name>.remote. branch.<name>.mergeOptions-
Sets default options for merging into branch <name>. The syntax and supported options are the same as those of git-merge[1], but option values containing whitespace characters are currently not supported.
branch.<name>.rebase-
When true, rebase the branch <name> on top of the fetched branch, instead of merging the default branch from the default remote when
gitpullis run. Seepull.rebasefor doing this in a non branch-specific manner.When
merges(or justm), pass the--rebase-mergesoption togitrebaseso that the local merge commits are included in the rebase (see git-rebase[1] for details).When the value is
interactive(or justi), the rebase is run in interactive mode.NOTE: this is a possibly dangerous operation; do not use it unless you understand the implications (see git-rebase[1] for details).
branch.<name>.description-
Branch description, can be edited with
gitbranch--edit-description. Branch description is automatically added to theformat-patchcover letter orrequest-pullsummary. - browser.<tool>.cmd
-
Specify the command to invoke the specified browser. The specified command is evaluated in shell with the URLs passed as arguments. (See git-web--browse[1].)
- browser.<tool>.path
-
Override the path for the given tool that may be used to browse HTML help (see
-woption in git-help[1]) or a working repository in gitweb (see git-instaweb[1]). - bundle.*
-
The
bundle.*keys may appear in a bundle list file found via thegitclone--bundle-urioption. These keys currently have no effect if placed in a repository config file, though this will change in the future. See the bundle URI design document for more details. - bundle.version
-
This integer value advertises the version of the bundle list format used by the bundle list. Currently, the only accepted value is
1. - bundle.mode
-
This string value should be either
allorany. This value describes whether all of the advertised bundles are required to unbundle a complete understanding of the bundled information (all) or if any one of the listed bundle URIs is sufficient (any). - bundle.heuristic
-
If this string-valued key exists, then the bundle list is designed to work well with incremental
gitfetchcommands. The heuristic signals that there are additional keys available for each bundle that help determine which subset of bundles the client should download. The only value currently understood iscreationToken. - bundle.<id>.*
-
The
bundle.<id>.*keys are used to describe a single item in the bundle list, grouped under <id> for identification purposes. - bundle.<id>.uri
-
This string value defines the URI by which Git can reach the contents of this <id>. This URI may be a bundle file or another bundle list.
checkout.defaultRemote-
When you run
gitcheckout<something> orgitswitch<something> and only have one remote, it may implicitly fall back on checking out and tracking e.g.origin/<something>. This stops working as soon as you have more than one remote with a <something> reference. This setting allows for setting the name of a preferred remote that should always win when it comes to disambiguation. The typical use-case is to set this toorigin.Currently this is used by git-switch[1] and git-checkout[1] when
gitcheckout<something> orgitswitch<something> will checkout the <something> branch on another remote, and by git-worktree[1] whengitworktreeaddrefers to a remote branch. This setting might be used for other checkout-like commands or functionality in the future. checkout.guess-
Provides the default value for the
--guessor--no-guessoption ingitcheckoutandgitswitch. See git-switch[1] and git-checkout[1]. checkout.workers-
The number of parallel workers to use when updating the working tree. The default is one, i.e. sequential execution. If set to a value less than one, Git will use as many workers as the number of logical cores available. This setting and
checkout.thresholdForParallelismaffect all commands that perform checkout. E.g. checkout, clone, reset, sparse-checkout, etc.NoteParallel checkout usually delivers better performance for repositories located on SSDs or over NFS. For repositories on spinning disks and/or machines with a small number of cores, the default sequential checkout often performs better. The size and compression level of a repository might also influence how well the parallel version performs. checkout.thresholdForParallelism-
When running parallel checkout with a small number of files, the cost of subprocess spawning and inter-process communication might outweigh the parallelization gains. This setting allows you to define the minimum number of files for which parallel checkout should be attempted. The default is 100.
- clean.requireForce
-
A boolean to make git-clean refuse to delete files unless -f is given. Defaults to true.
clone.defaultRemoteName-
The name of the remote to create when cloning a repository. Defaults to
origin. It can be overridden by passing the--origincommand-line option to git-clone[1]. clone.rejectShallow-
Reject cloning a repository if it is a shallow one; this can be overridden by passing the
--reject-shallowoption on the command line. See git-clone[1]. clone.filterSubmodules-
If a partial clone filter is provided (see
--filterin git-rev-list[1]) and--recurse-submodulesis used, also apply the filter to submodules. - color.advice
-
A boolean to enable/disable color in hints (e.g. when a push failed, see
advice.*for a list). May be set toalways,false(ornever) orauto(ortrue), in which case colors are used only when the error output goes to a terminal. If unset, then the value ofcolor.uiis used (autoby default). - color.advice.hint
-
Use customized color for hints.
- color.blame.highlightRecent
-
Specify the line annotation color for
gitblame--color-by-agedepending upon the age of the line.This setting should be set to a comma-separated list of color and date settings, starting and ending with a color, the dates should be set from oldest to newest. The metadata will be colored with the specified colors if the line was introduced before the given timestamp, overwriting older timestamped colors.
Instead of an absolute timestamp relative timestamps work as well, e.g.
2.weeks.agois valid to address anything older than 2 weeks.It defaults to
blue,12monthago,white,1monthago,red, which colors everything older than one year blue, recent changes between one month and one year old are kept white, and lines introduced within the last month are colored red. - color.blame.repeatedLines
-
Use the specified color to colorize line annotations for
gitblame--color-lines, if they come from the same commit as the preceding line. Defaults to cyan. - color.branch
-
A boolean to enable/disable color in the output of git-branch[1]. May be set to
always,false(ornever) orauto(ortrue), in which case colors are used only when the output is to a terminal. If unset, then the value ofcolor.uiis used (autoby default). - color.branch.<slot>
-
Use customized color for branch coloration. <slot> is one of
current(the current branch),local(a local branch),remote(a remote-tracking branch in refs/remotes/),upstream(upstream tracking branch),plain(other refs). - color.diff
-
Whether to use ANSI escape sequences to add color to patches. If this is set to
always, git-diff[1], git-log[1], and git-show[1] will use color for all patches. If it is set totrueorauto, those commands will only use color when output is to the terminal. If unset, then the value ofcolor.uiis used (autoby default).This does not affect git-format-patch[1] or the git-diff-* plumbing commands. Can be overridden on the command line with the
--color[=<when>] option. - color.diff.<slot>
-
Use customized color for diff colorization. <slot> specifies which part of the patch to use the specified color, and is one of
context(context text -plainis a historical synonym),meta(metainformation),frag(hunk header), func (function in hunk header),old(removed lines),new(added lines),commit(commit headers),whitespace(highlighting whitespace errors),oldMoved(deleted lines),newMoved(added lines),oldMovedDimmed,oldMovedAlternative,oldMovedAlternativeDimmed,newMovedDimmed,newMovedAlternativenewMovedAlternativeDimmed(See the <mode> setting of --color-moved in git-diff[1] for details),contextDimmed,oldDimmed,newDimmed,contextBold,oldBold, andnewBold(see git-range-diff[1] for details). - color.decorate.<slot>
-
Use customized color for git log --decorate output. <slot> is one of
branch,remoteBranch,tag,stashorHEADfor local branches, remote-tracking branches, tags, stash and HEAD, respectively andgraftedfor grafted commits. - color.grep
-
When set to
always, always highlight matches. Whenfalse(ornever), never. When set totrueorauto, use color only when the output is written to the terminal. If unset, then the value ofcolor.uiis used (autoby default). - color.grep.<slot>
-
Use customized color for grep colorization. <slot> specifies which part of the line to use the specified color, and is one of
context-
non-matching text in context lines (when using
-A,-B, or-C) filename-
filename prefix (when not using
-h) function-
function name lines (when using
-p) lineNumber-
line number prefix (when using
-n) column-
column number prefix (when using
--column) match-
matching text (same as setting
matchContextandmatchSelected) matchContext-
matching text in context lines
matchSelected-
matching text in selected lines. Also, used to customize the following git-log[1] subcommands:
--grep,--author, and--committer. selected-
non-matching text in selected lines. Also, used to customize the following git-log[1] subcommands:
--grep,--authorand--committer. separator-
separators between fields on a line (
:,-, and=) and between hunks (--)
- color.interactive
-
When set to
always, always use colors for interactive prompts and displays (such as those used by "git-add --interactive" and "git-clean --interactive"). When false (ornever), never. When set totrueorauto, use colors only when the output is to the terminal. If unset, then the value ofcolor.uiis used (autoby default). - color.interactive.<slot>
-
Use customized color for git add --interactive and git clean --interactive output. <slot> may be
prompt,header,helporerror, for four distinct types of normal output from interactive commands. - color.pager
-
A boolean to specify whether
autocolor modes should colorize output going to the pager. Defaults to true; set this to false if your pager does not understand ANSI color codes. - color.push
-
A boolean to enable/disable color in push errors. May be set to
always,false(ornever) orauto(ortrue), in which case colors are used only when the error output goes to a terminal. If unset, then the value ofcolor.uiis used (autoby default). - color.push.error
-
Use customized color for push errors.
- color.remote
-
If set, keywords at the start of the line are highlighted. The keywords are "error", "warning", "hint" and "success", and are matched case-insensitively. May be set to
always,false(ornever) orauto(ortrue). If unset, then the value ofcolor.uiis used (autoby default). - color.remote.<slot>
-
Use customized color for each remote keyword. <slot> may be
hint,warning,successorerrorwhich match the corresponding keyword. - color.showBranch
-
A boolean to enable/disable color in the output of git-show-branch[1]. May be set to
always,false(ornever) orauto(ortrue), in which case colors are used only when the output is to a terminal. If unset, then the value ofcolor.uiis used (autoby default). - color.status
-
A boolean to enable/disable color in the output of git-status[1]. May be set to
always,false(ornever) orauto(ortrue), in which case colors are used only when the output is to a terminal. If unset, then the value ofcolor.uiis used (autoby default). - color.status.<slot>
-
Use customized color for status colorization. <slot> is one of
header(the header text of the status message),addedorupdated(files which are added but not committed),changed(files which are changed but not added in the index),untracked(files which are not tracked by Git),branch(the current branch),nobranch(the color the no branch warning is shown in, defaulting to red),localBranchorremoteBranch(the local and remote branch names, respectively, when branch and tracking information is displayed in the status short-format), orunmerged(files which have unmerged changes). - color.transport
-
A boolean to enable/disable color when pushes are rejected. May be set to
always,false(ornever) orauto(ortrue), in which case colors are used only when the error output goes to a terminal. If unset, then the value ofcolor.uiis used (autoby default). - color.transport.rejected
-
Use customized color when a push was rejected.
- color.ui
-
This variable determines the default value for variables such as
color.diffandcolor.grepthat control the use of color per command family. Its scope will expand as more commands learn configuration to set a default for the--coloroption. Set it tofalseorneverif you prefer Git commands not to use color unless enabled explicitly with some other configuration or the--coloroption. Set it toalwaysif you want all output not intended for machine consumption to use color, totrueorauto(this is the default since Git 1.8.4) if you want such output to use color when written to the terminal. - column.ui
-
Specify whether supported commands should output in columns. This variable consists of a list of tokens separated by spaces or commas:
These options control when the feature should be enabled (defaults to never):
These options control layout (defaults to column). Setting any of these implies always if none of always, never, or auto are specified.
Finally, these options can be combined with a layout option (defaults to nodense):
- column.branch
-
Specify whether to output branch listing in
gitbranchin columns. Seecolumn.uifor details. - column.clean
-
Specify the layout when listing items in
gitclean-i, which always shows files and directories in columns. Seecolumn.uifor details. - column.status
-
Specify whether to output untracked files in
gitstatusin columns. Seecolumn.uifor details. - column.tag
-
Specify whether to output tag listings in
gittagin columns. Seecolumn.uifor details.
commit.cleanup-
This setting overrides the default of the
--cleanupoption ingitcommit. See git-commit[1] for details. Changing the default can be useful when you always want to keep lines that begin with the comment character (core.commentChar, default#) in your log message, in which case you would dogitconfigcommit.cleanupwhitespace(note that you will have to remove the help lines that begin with the comment character in the commit log template yourself, if you do this). commit.gpgSign-
A boolean to specify whether all commits should be GPG signed. Use of this option when doing operations such as rebase can result in a large number of commits being signed. It may be convenient to use an agent to avoid typing your GPG passphrase several times.
commit.status-
A boolean to enable/disable inclusion of status information in the commit message template when using an editor to prepare the commit message. Defaults to
true. commit.template-
Specify the pathname of a file to use as the template for new commit messages.
commit.verbose-
A boolean or int to specify the level of verbosity with
gitcommit. See git-commit[1] for details. - commitGraph.generationVersion
-
Specifies the type of generation number version to use when writing or reading the commit-graph file. If version 1 is specified, then the corrected commit dates will not be written or read. Defaults to 2.
- commitGraph.maxNewFilters
-
Specifies the default value for the
--max-new-filtersoption ofgitcommit-graphwrite(c.f., git-commit-graph[1]). - commitGraph.changedPaths
-
If true, then
gitcommit-graphwritewill compute and write changed-path Bloom filters by default, equivalent to passing--changed-paths. If false or unset, changed-paths Bloom filters will be written duringgitcommit-graphwriteonly if the filters already exist in the current commit-graph file. This matches the default behavior ofgitcommit-graphwritewithout any--[no-]changed-pathsoption. To rewrite a commit-graph file without any filters, use the--no-changed-pathsoption. Command-line option--[no-]changed-pathsalways takes precedence over this configuration. Defaults to unset. - commitGraph.readChangedPaths
-
Deprecated. Equivalent to commitGraph.changedPathsVersion=-1 if true, and commitGraph.changedPathsVersion=0 if false. (If commitGraph.changedPathVersion is also set, commitGraph.changedPathsVersion takes precedence.)
- commitGraph.changedPathsVersion
-
Specifies the version of the changed-path Bloom filters that Git will read and write. May be -1, 0, 1, or 2. Note that values greater than 1 may be incompatible with older versions of Git which do not yet understand those versions. Use caution when operating in a mixed-version environment.
Defaults to -1.
If -1, Git will use the version of the changed-path Bloom filters in the repository, defaulting to 1 if there are none.
If 0, Git will not read any Bloom filters, and will write version 1 Bloom filters when instructed to write.
If 1, Git will only read version 1 Bloom filters, and will write version 1 Bloom filters.
If 2, Git will only read version 2 Bloom filters, and will write version 2 Bloom filters.
See git-commit-graph[1] for more information.
- completion.commands
-
This is only used by git-completion.bash to add or remove commands from the list of completed commands. Normally only porcelain commands and a few select others are completed. You can add more commands, separated by space, in this variable. Prefixing the command with - will remove it from the existing list.
- core.fileMode
-
Tells Git if the executable bit of files in the working tree is to be honored.
Some filesystems lose the executable bit when a file that is marked as executable is checked out, or checks out a non-executable file with executable bit on. git-clone[1] or git-init[1] probe the filesystem to see if it handles the executable bit correctly and this variable is automatically set as necessary.
A repository, however, may be on a filesystem that handles the filemode correctly, and this variable is set to true when created, but later may be made accessible from another environment that loses the filemode (e.g. exporting ext4 via CIFS mount, visiting a Cygwin created repository with Git for Windows or Eclipse). In such a case it may be necessary to set this variable to false. See git-update-index[1].
The default is true (when core.filemode is not specified in the config file).
- core.hideDotFiles
-
(Windows-only) If true, mark newly-created directories and files whose name starts with a dot as hidden. If dotGitOnly, only the
.git/directory is hidden, but no other files starting with a dot. The default mode is dotGitOnly. - core.ignoreCase
-
Internal variable which enables various workarounds to enable Git to work better on filesystems that are not case sensitive, like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing finds "makefile" when Git expects "Makefile", Git will assume it is really the same file, and continue to remember it as "Makefile".
The default is false, except git-clone[1] or git-init[1] will probe and set core.ignoreCase true if appropriate when the repository is created.
Git relies on the proper configuration of this variable for your operating and file system. Modifying this value may result in unexpected behavior.
- core.precomposeUnicode
-
This option is only used by Mac OS implementation of Git. When core.precomposeUnicode=true, Git reverts the unicode decomposition of filenames done by Mac OS. This is useful when sharing a repository between Mac OS and Linux or Windows. (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). When false, file names are handled fully transparent by Git, which is backward compatible with older versions of Git.
- core.protectHFS
-
If set to true, do not allow checkout of paths that would be considered equivalent to
.giton an HFS+ filesystem. Defaults totrueon Mac OS, andfalseelsewhere. - core.protectNTFS
-
If set to true, do not allow checkout of paths that would cause problems with the NTFS filesystem, e.g. conflict with 8.3 "short" names. Defaults to
trueon Windows, andfalseelsewhere. - core.fsmonitor
-
If set to true, enable the built-in file system monitor daemon for this working directory (git-fsmonitor--daemon[1]).
Like hook-based file system monitors, the built-in file system monitor can speed up Git commands that need to refresh the Git index (e.g.
gitstatus) in a working directory with many files. The built-in monitor eliminates the need to install and maintain an external third-party tool.The built-in file system monitor is currently available only on a limited set of supported platforms. Currently, this includes Windows and MacOS.
Otherwise, this variable contains the pathname of the "fsmonitor" hook command.
This hook command is used to identify all files that may have changed since the requested date/time. This information is used to speed up git by avoiding unnecessary scanning of files that have not changed.
See the "fsmonitor-watchman" section of githooks[5].
Note that if you concurrently use multiple versions of Git, such as one version on the command line and another version in an IDE tool, that the definition of
core.fsmonitorwas extended to allow boolean values in addition to hook pathnames. Git versions 2.35.1 and prior will not understand the boolean values and will consider the "true" or "false" values as hook pathnames to be invoked. Git versions 2.26 thru 2.35.1 default to hook protocol V2 and will fall back to no fsmonitor (full scan). Git versions prior to 2.26 default to hook protocol V1 and will silently assume there were no changes to report (no scan), so status commands may report incomplete results. For this reason, it is best to upgrade all of your Git versions before using the built-in file system monitor. - core.fsmonitorHookVersion
-
Sets the protocol version to be used when invoking the "fsmonitor" hook.
There are currently versions 1 and 2. When this is not set, version 2 will be tried first and if it fails then version 1 will be tried. Version 1 uses a timestamp as input to determine which files have changes since that time but some monitors like Watchman have race conditions when used with a timestamp. Version 2 uses an opaque string so that the monitor can return something that can be used to determine what files have changed without race conditions.
- core.trustctime
-
If false, the ctime differences between the index and the working tree are ignored; useful when the inode change time is regularly modified by something outside Git (file system crawlers and some backup systems). See git-update-index[1]. True by default.
- core.splitIndex
-
If true, the split-index feature of the index will be used. See git-update-index[1]. False by default.
- core.untrackedCache
-
Determines what to do about the untracked cache feature of the index. It will be kept, if this variable is unset or set to
keep. It will automatically be added if set totrue. And it will automatically be removed, if set tofalse. Before setting it totrue, you should check that mtime is working properly on your system. See git-update-index[1].keepby default, unlessfeature.manyFilesis enabled which sets this setting totrueby default. - core.checkStat
-
When missing or is set to
default, many fields in the stat structure are checked to detect if a file has been modified since Git looked at it. When this configuration variable is set tominimal, sub-second part of mtime and ctime, the uid and gid of the owner of the file, the inode number (and the device number, if Git was compiled to use it), are excluded from the check among these fields, leaving only the whole-second part of mtime (and ctime, ifcore.trustCtimeis set) and the filesize to be checked.There are implementations of Git that do not leave usable values in some fields (e.g. JGit); by excluding these fields from the comparison, the
minimalmode may help interoperability when the same repository is used by these other systems at the same time. - core.quotePath
-
Commands that output paths (e.g. ls-files, diff), will quote "unusual" characters in the pathname by enclosing the pathname in double-quotes and escaping those characters with backslashes in the same way C escapes control characters (e.g. \t for TAB, \n for LF, \\ for backslash) or bytes with values larger than 0x80 (e.g. octal \302\265 for "micro" in UTF-8). If this variable is set to false, bytes higher than 0x80 are not considered "unusual" any more. Double-quotes, backslash and control characters are always escaped regardless of the setting of this variable. A simple space character is not considered "unusual". Many commands can output pathnames completely verbatim using the
-zoption. The default value is true. - core.eol
-
Sets the line ending type to use in the working directory for files that are marked as text (either by having the
textattribute set, or by havingtext=autoand Git auto-detecting the contents as text). Alternatives are lf, crlf and native, which uses the platform’s native line ending. The default value isnative. See gitattributes[5] for more information on end-of-line conversion. Note that this value is ignored ifcore.autocrlfis set totrueorinput. - core.safecrlf
-
If true, makes Git check if converting
CRLFis reversible when end-of-line conversion is active. Git will verify if a command modifies a file in the work tree either directly or indirectly. For example, committing a file followed by checking out the same file should yield the original file in the work tree. If this is not the case for the current setting ofcore.autocrlf, Git will reject the file. The variable can be set to "warn", in which case Git will only warn about an irreversible conversion but continue the operation.CRLF conversion bears a slight chance of corrupting data. When it is enabled, Git will convert CRLF to LF during commit and LF to CRLF during checkout. A file that contains a mixture of LF and CRLF before the commit cannot be recreated by Git. For text files this is the right thing to do: it corrects line endings such that we have only LF line endings in the repository. But for binary files that are accidentally classified as text the conversion can corrupt data.
If you recognize such corruption early you can easily fix it by setting the conversion type explicitly in .gitattributes. Right after committing you still have the original file in your work tree and this file is not yet corrupted. You can explicitly tell Git that this file is binary and Git will handle the file appropriately.
Unfortunately, the desired effect of cleaning up text files with mixed line endings and the undesired effect of corrupting binary files cannot be distinguished. In both cases CRLFs are removed in an irreversible way. For text files this is the right thing to do because CRLFs are line endings, while for binary files converting CRLFs corrupts data.
Note, this safety check does not mean that a checkout will generate a file identical to the original file for a different setting of
core.eolandcore.autocrlf, but only for the current one. For example, a text file withLFwould be accepted withcore.eol=lfand could later be checked out withcore.eol=crlf, in which case the resulting file would containCRLF, although the original file containedLF. However, in both work trees the line endings would be consistent, that is either allLFor allCRLF, but never mixed. A file with mixed line endings would be reported by thecore.safecrlfmechanism. - core.autocrlf
-
Setting this variable to "true" is the same as setting the
textattribute to "auto" on all files and core.eol to "crlf". Set to true if you want to haveCRLFline endings in your working directory and the repository has LF line endings. This variable can be set to input, in which case no output conversion is performed. - core.checkRoundtripEncoding
-
A comma and/or whitespace separated list of encodings that Git performs UTF-8 round trip checks on if they are used in an
working-tree-encodingattribute (see gitattributes[5]). The default value isSHIFT-JIS. - core.symlinks
-
If false, symbolic links are checked out as small plain files that contain the link text. git-update-index[1] and git-add[1] will not change the recorded type to regular file. Useful on filesystems like FAT that do not support symbolic links.
The default is true, except git-clone[1] or git-init[1] will probe and set core.symlinks false if appropriate when the repository is created.
- core.gitProxy
-
A "proxy command" to execute (as command host port) instead of establishing direct connection to the remote server when using the Git protocol for fetching. If the variable value is in the "COMMAND for DOMAIN" format, the command is applied only on hostnames ending with the specified domain string. This variable may be set multiple times and is matched in the given order; the first match wins.
Can be overridden by the
GIT_PROXY_COMMANDenvironment variable (which always applies universally, without the special "for" handling).The special string
nonecan be used as the proxy command to specify that no proxy be used for a given domain pattern. This is useful for excluding servers inside a firewall from proxy use, while defaulting to a common proxy for external domains. - core.sshCommand
-
If this variable is set,
gitfetchandgitpushwill use the specified command instead ofsshwhen they need to connect to a remote system. The command is in the same form as theGIT_SSH_COMMANDenvironment variable and is overridden when the environment variable is set. - core.ignoreStat
-
If true, Git will avoid using lstat() calls to detect if files have changed by setting the "assume-unchanged" bit for those tracked files which it has updated identically in both the index and working tree.
When files are modified outside of Git, the user will need to stage the modified files explicitly (e.g. see Examples section in git-update-index[1]). Git will not normally detect changes to those files.
This is useful on systems where lstat() calls are very slow, such as CIFS/Microsoft Windows.
False by default.
- core.preferSymlinkRefs
-
Instead of the default "symref" format for HEAD and other symbolic reference files, use symbolic links. This is sometimes needed to work with old scripts that expect HEAD to be a symbolic link.
This configuration is deprecated and will be removed in Git 3.0. Symbolic refs will always be written as textual symrefs.
- core.alternateRefsCommand
-
When advertising tips of available history from an alternate, use the shell to execute the specified command instead of git-for-each-ref[1]. The first argument is the absolute path of the alternate. Output must contain one hex object id per line (i.e., the same as produced by
gitfor-each-ref--format='%(objectname)).Note that you cannot generally put
gitfor-each-refdirectly into the config value, as it does not take a repository path as an argument (but you can wrap the command above in a shell script). - core.alternateRefsPrefixes
-
When listing references from an alternate, list only references that begin with the given prefix. Prefixes match as if they were given as arguments to git-for-each-ref[1]. To list multiple prefixes, separate them with whitespace. If
core.alternateRefsCommandis set, settingcore.alternateRefsPrefixeshas no effect. - core.bare
-
If true this repository is assumed to be bare and has no working directory associated with it. If this is the case a number of commands that require a working directory will be disabled, such as git-add[1] or git-merge[1].
This setting is automatically guessed by git-clone[1] or git-init[1] when the repository was created. By default a repository that ends in "/.git" is assumed to be not bare (bare = false), while all other repositories are assumed to be bare (bare = true).
- core.worktree
-
Set the path to the root of the working tree. If
GIT_COMMON_DIRenvironment variable is set, core.worktree is ignored and not used for determining the root of working tree. This can be overridden by theGIT_WORK_TREEenvironment variable and the--work-treecommand-line option. The value can be an absolute path or relative to the path to the .git directory, which is either specified by --git-dir or GIT_DIR, or automatically discovered. If --git-dir or GIT_DIR is specified but none of --work-tree, GIT_WORK_TREE and core.worktree is specified, the current working directory is regarded as the top level of your working tree.Note that this variable is honored even when set in a configuration file in a ".git" subdirectory of a directory and its value differs from the latter directory (e.g. "/path/to/.git/config" has core.worktree set to "/different/path"), which is most likely a misconfiguration. Running Git commands in the "/path/to" directory will still use "/different/path" as the root of the work tree and can cause confusion unless you know what you are doing (e.g. you are creating a read-only snapshot of the same index to a location different from the repository’s usual working tree).
- core.logAllRefUpdates
-
Enable the reflog. Updates to a ref <ref> is logged to the file "
$GIT_DIR/logs/<ref>", by appending the new and old SHA-1, the date/time and the reason of the update, but only when the file exists. If this configuration variable is set totrue, missing "$GIT_DIR/logs/<ref>" file is automatically created for branch heads (i.e. underrefs/heads/), remote refs (i.e. underrefs/remotes/), note refs (i.e. underrefs/notes/), and the symbolic refHEAD. If it is set toalways, then a missing reflog is automatically created for any ref underrefs/.This information can be used to determine what commit was the tip of a branch "2 days ago".
This value is true by default in a repository that has a working directory associated with it, and false by default in a bare repository.
- core.repositoryFormatVersion
-
Internal variable identifying the repository format and layout version. See gitrepository-layout[5].
-
When group (or true), the repository is made shareable between several users in a group (making sure all the files and objects are group-writable). When all (or world or everybody), the repository will be readable by all users, additionally to being group-shareable. When umask (or false), Git will use permissions reported by umask(2). When 0xxx, where 0xxx is an octal number, files in the repository will have this mode value. 0xxx will override user’s umask value (whereas the other options will only override requested parts of the user’s umask value). Examples: 0660 will make the repo read/write-able for the owner and group, but inaccessible to others (equivalent to group unless umask is e.g. 0022). 0640 is a repository that is group-readable but not group-writable. See git-init[1]. False by default.
- core.warnAmbiguousRefs
-
If true, Git will warn you if the ref name you passed it is ambiguous and might match multiple refs in the repository. True by default.
- core.compression
-
An integer -1..9, indicating a default compression level. -1 is the zlib default. 0 means no compression, and 1..9 are various speed/size tradeoffs, 9 being slowest. If set, this provides a default to other compression variables, such as
core.looseCompressionandpack.compression. - core.looseCompression
-
An integer -1..9, indicating the compression level for objects that are not in a pack file. -1 is the zlib default. 0 means no compression, and 1..9 are various speed/size tradeoffs, 9 being slowest. If not set, defaults to core.compression. If that is not set, defaults to 1 (best speed).
- core.packedGitWindowSize
-
Number of bytes of a pack file to map into memory in a single mapping operation. Larger window sizes may allow your system to process a smaller number of large pack files more quickly. Smaller window sizes will negatively affect performance due to increased calls to the operating system’s memory manager, but may improve performance when accessing a large number of large pack files.
Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should be reasonable for all users/operating systems. You probably do not need to adjust this value.
Common unit suffixes of k, m, or g are supported.
- core.packedGitLimit
-
Maximum number of bytes to map simultaneously into memory from pack files. If Git needs to access more than this many bytes at once to complete an operation it will unmap existing regions to reclaim virtual address space within the process.
Default is 256 MiB on 32 bit platforms and 32 TiB (effectively unlimited) on 64 bit platforms. This should be reasonable for all users/operating systems, except on the largest projects. You probably do not need to adjust this value.
Common unit suffixes of k, m, or g are supported.
- core.deltaBaseCacheLimit
-
Maximum number of bytes per thread to reserve for caching base objects that may be referenced by multiple deltified objects. By storing the entire decompressed base objects in a cache Git is able to avoid unpacking and decompressing frequently used base objects multiple times.
Default is 96 MiB on all platforms. This should be reasonable for all users/operating systems, except on the largest projects. You probably do not need to adjust this value.
Common unit suffixes of k, m, or g are supported.
- core.bigFileThreshold
-
The size of files considered "big", which as discussed below changes the behavior of numerous git commands, as well as how such files are stored within the repository. The default is 512 MiB. Common unit suffixes of k, m, or g are supported.
Files above the configured limit will be:
-
Stored deflated in packfiles, without attempting delta compression.
The default limit is primarily set with this use-case in mind. With it, most projects will have their source code and other text files delta compressed, but not larger binary media files.
Storing large files without delta compression avoids excessive memory usage, at the slight expense of increased disk usage.
-
Will be treated as if they were labeled "binary" (see gitattributes[5]). e.g. git-log[1] and git-diff[1] will not compute diffs for files above this limit.
-
Will generally be streamed when written, which avoids excessive memory usage, at the cost of some fixed overhead. Commands that make use of this include git-archive[1], git-fast-import[1], git-index-pack[1], git-unpack-objects[1] and git-fsck[1].
-
- core.excludesFile
-
Specifies the pathname to the file that contains patterns to describe paths that are not meant to be tracked, in addition to
.gitignore(per-directory) and.git/info/exclude. Defaults to$XDG_CONFIG_HOME/git/ignore. If$XDG_CONFIG_HOMEis either not set or empty,$HOME/.config/git/ignoreis used instead. See gitignore[5]. - core.askPass
-
Some commands (e.g. svn and http interfaces) that interactively ask for a password can be told to use an external program given via the value of this variable. Can be overridden by the
GIT_ASKPASSenvironment variable. If not set, fall back to the value of theSSH_ASKPASSenvironment variable or, failing that, a simple password prompt. The external program shall be given a suitable prompt as command-line argument and write the password on its STDOUT. - core.attributesFile
-
In addition to
.gitattributes(per-directory) and.git/info/attributes, Git looks into this file for attributes (see gitattributes[5]). Path expansions are made the same way as forcore.excludesFile. Its default value is$XDG_CONFIG_HOME/git/attributes. If$XDG_CONFIG_HOMEis either not set or empty,$HOME/.config/git/attributesis used instead. - core.hooksPath
-
By default Git will look for your hooks in the
$GIT_DIR/hooksdirectory. Set this to different path, e.g./etc/git/hooks, and Git will try to find your hooks in that directory, e.g./etc/git/hooks/pre-receiveinstead of in$GIT_DIR/hooks/pre-receive.The path can be either absolute or relative. A relative path is taken as relative to the directory where the hooks are run (see the "DESCRIPTION" section of githooks[5]).
This configuration variable is useful in cases where you’d like to centrally configure your Git hooks instead of configuring them on a per-repository basis, or as a more flexible and centralized alternative to having an
init.templateDirwhere you’ve changed default hooks.You can also disable all hooks entirely by setting
core.hooksPathto/dev/null. This is usually only advisable for expert users and on a per-command basis using configuration parameters of the formgit-ccore.hooksPath=/dev/null.... - core.editor
-
Commands such as
commitandtagthat let you edit messages by launching an editor use the value of this variable when it is set, and the environment variableGIT_EDITORis not set. See git-var[1]. - core.commentChar
- core.commentString
-
Commands such as
commitandtagthat let you edit messages consider a line that begins with this character commented, and removes them after the editor returns (default #).If set to "auto",
git-commitwill select a character that is not the beginning character of any line in existing commit messages. Support for this value is deprecated and will be removed in Git 3.0 due to the following limitations:-
It is incompatible with adding comments in a commit message template. This includes the conflicts comments added to the commit message by
cherry-pick,merge,rebaseandrevert. -
It is incompatible with adding comments to the commit message in the
prepare-commit-msghook. -
It is incompatible with the
fixupandsquashcommands when rebasing, -
It is not respected by
gitnotes
Note that these two variables are aliases of each other, and in modern versions of Git you are free to use a string (e.g.,
//or ⁑⁕⁑) withcommentChar. Versions of Git prior to v2.45.0 will ignorecommentStringbut will reject a value ofcommentCharthat consists of more than a single ASCII byte. If you plan to use your config with older and newer versions of Git, you may want to specify both:[core] # single character for older versions commentChar = "#" # string for newer versions (which will override commentChar # because it comes later in the file) commentString = "//"
-
- core.filesRefLockTimeout
-
The length of time, in milliseconds, to retry when trying to lock an individual reference. Value 0 means not to retry at all; -1 means to try indefinitely. Default is 100 (i.e., retry for 100ms).
- core.packedRefsTimeout
-
The length of time, in milliseconds, to retry when trying to lock the
packed-refsfile. Value 0 means not to retry at all; -1 means to try indefinitely. Default is 1000 (i.e., retry for 1 second). - core.pager
-
Text viewer for use by Git commands (e.g., less). The value is meant to be interpreted by the shell. The order of preference is the
$GIT_PAGERenvironment variable, thencore.pagerconfiguration, then$PAGER, and then the default chosen at compile time (usually less).When the
LESSenvironment variable is unset, Git sets it toFRX(ifLESSenvironment variable is set, Git does not change it at all). If you want to selectively override Git’s default setting forLESS, you can setcore.pagerto e.g.less-S. This will be passed to the shell by Git, which will translate the final command toLESS=FRXless-S. The environment does not set theSoption but the command line does, instructing less to truncate long lines. Similarly, settingcore.pagertoless-+Fwill deactivate theFoption specified by the environment from the command-line, deactivating the "quit if one screen" behavior ofless. One can specifically activate some flags for particular commands: for example, settingpager.blametoless-Senables line truncation only forgitblame.Likewise, when the
LVenvironment variable is unset, Git sets it to-c. You can override this setting by exportingLVwith another value or settingcore.pagertolv+c. - core.whitespace
-
A comma separated list of common whitespace problems to notice. git diff will use
color.diff.whitespaceto highlight them, and git apply --whitespace=error will consider them as errors. You can prefix-to disable any of them (e.g.-trailing-space):-
blank-at-eoltreats trailing whitespaces at the end of the line as an error (enabled by default). -
space-before-tabtreats a space character that appears immediately before a tab character in the initial indent part of the line as an error (enabled by default). -
indent-with-non-tabtreats a line that is indented with space characters instead of the equivalent tabs as an error (not enabled by default). -
tab-in-indenttreats a tab character in the initial indent part of the line as an error (not enabled by default). -
blank-at-eoftreats blank lines added at the end of file as an error (enabled by default). -
trailing-spaceis a short-hand to cover bothblank-at-eolandblank-at-eof. -
cr-at-eoltreats a carriage-return at the end of line as part of the line terminator, i.e. with it,trailing-spacedoes not trigger if the character before such a carriage-return is not a whitespace (not enabled by default). -
tabwidth=<n> tells how many character positions a tab occupies; this is relevant forindent-with-non-taband when Git fixestab-in-indenterrors. The default tab width is 8. Allowed values are 1 to 63.
-
- core.fsync
-
A comma-separated list of components of the repository that should be hardened via the core.fsyncMethod when created or modified. You can disable hardening of any component by prefixing it with a -. Items that are not hardened may be lost in the event of an unclean system shutdown. Unless you have special requirements, it is recommended that you leave this option empty or pick one of
committed,added, orall.When this configuration is encountered, the set of components starts with the platform default value, disabled components are removed, and additional components are added.
noneresets the state so that the platform default is ignored.The empty string resets the fsync configuration to the platform default. The default on most platforms is equivalent to
core.fsync=committed,-loose-object, which has good performance, but risks losing recent work in the event of an unclean system shutdown.-
noneclears the set of fsynced components. -
loose-objecthardens objects added to the repo in loose-object form. -
packhardens objects added to the repo in packfile form. -
pack-metadatahardens packfile bitmaps and indexes. -
commit-graphhardens the commit-graph file. -
indexhardens the index when it is modified. -
objectsis an aggregate option that is equivalent toloose-object,pack. -
referencehardens references modified in the repo. -
derived-metadatais an aggregate option that is equivalent topack-metadata,commit-graph. -
committedis an aggregate option that is currently equivalent toobjects. This mode sacrifices some performance to ensure that work that is committed to the repository withgitcommitor similar commands is hardened. -
addedis an aggregate option that is currently equivalent tocommitted,index. This mode sacrifices additional performance to ensure that the results of commands likegitaddand similar operations are hardened. -
allis an aggregate option that syncs all individual components above.
-
- core.fsyncMethod
-
A value indicating the strategy Git will use to harden repository data using fsync and related primitives.
-
fsyncuses the fsync() system call or platform equivalents. -
writeout-onlyissues pagecache writeback requests, but depending on the filesystem and storage hardware, data added to the repository may not be durable in the event of a system crash. This is the default mode on macOS. -
batchenables a mode that uses writeout-only flushes to stage multiple updates in the disk writeback cache and then does a single full fsync of a dummy file to trigger the disk cache flush at the end of the operation.Currently
batchmode only applies to loose-object files. Other repository data is made durable as iffsyncwas specified. This mode is expected to be as safe asfsyncon macOS for repos stored on HFS+ or APFS filesystems and on Windows for repos stored on NTFS or ReFS filesystems.
-
- core.fsyncObjectFiles
-
This boolean will enable fsync() when writing object files. This setting is deprecated. Use core.fsync instead.
This setting affects data added to the Git repository in loose-object form. When set to true, Git will issue an fsync or similar system call to flush caches so that loose-objects remain consistent in the face of a unclean system shutdown.
- core.preloadIndex
-
Enable parallel index preload for operations like git diff
This can speed up operations like git diff and git status especially on filesystems like NFS that have weak caching semantics and thus relatively high IO latencies. When enabled, Git will do the index comparison to the filesystem data in parallel, allowing overlapping IO’s. Defaults to true.
- core.unsetenvvars
-
Windows-only: comma-separated list of environment variables' names that need to be unset before spawning any other process. Defaults to
PERL5LIBto account for the fact that Git for Windows insists on using its own Perl interpreter. - core.createObject
-
You can set this to link, in which case a hardlink followed by a delete of the source are used to make sure that object creation will not overwrite existing objects.
On some file system/operating system combinations, this is unreliable. Set this config setting to rename there; however, this will remove the check that makes sure that existing object files will not get overwritten.
- core.notesRef
-
When showing commit messages, also show notes which are stored in the given ref. The ref must be fully qualified. If the given ref does not exist, it is not an error but means that no notes should be printed.
This setting defaults to "refs/notes/commits", and it can be overridden by the
GIT_NOTES_REFenvironment variable. See git-notes[1]. - core.commitGraph
-
If true, then git will read the commit-graph file (if it exists) to parse the graph structure of commits. Defaults to true. See git-commit-graph[1] for more information.
- core.useReplaceRefs
-
If set to
false, behave as if the--no-replace-objectsoption was given on the command line. See git[1] and git-replace[1] for more information. - core.multiPackIndex
-
Use the multi-pack-index file to track multiple packfiles using a single index. See git-multi-pack-index[1] for more information. Defaults to true.
- core.sparseCheckout
-
Enable "sparse checkout" feature. See git-sparse-checkout[1] for more information.
- core.sparseCheckoutCone
-
Enables the "cone mode" of the sparse checkout feature. When the sparse-checkout file contains a limited set of patterns, this mode provides significant performance advantages. The "non-cone mode" can be requested to allow specifying more flexible patterns by setting this variable to false. See git-sparse-checkout[1] for more information.
- core.abbrev
-
Set the length object names are abbreviated to. If unspecified or set to "auto", an appropriate value is computed based on the approximate number of packed objects in your repository, which hopefully is enough for abbreviated object names to stay unique for some time. If set to "no", no abbreviation is made and the object names are shown in their full length. The minimum length is 4.
- core.maxTreeDepth
-
The maximum depth Git is willing to recurse while traversing a tree (e.g., "a/b/cde/f" has a depth of 4). This is a fail-safe to allow Git to abort cleanly, and should not generally need to be adjusted. When Git is compiled with MSVC, the default is 512. Otherwise, the default is 2048.
- credential.helper
-
Specify an external helper to be called when a username or password credential is needed; the helper may consult external storage to avoid prompting the user for the credentials. This is normally the name of a credential helper with possible arguments, but may also be an absolute path with arguments or, if preceded by
!, shell commands.Note that multiple helpers may be defined. See gitcredentials[7] for details and examples.
- credential.interactive
-
By default, Git and any configured credential helpers will ask for user input when new credentials are required. Many of these helpers will succeed based on stored credentials if those credentials are still valid. To avoid the possibility of user interactivity from Git, set
credential.interactive=false. Some credential helpers respect this option as well. - credential.useHttpPath
-
When acquiring credentials, consider the "path" component of an http or https URL to be important. Defaults to false. See gitcredentials[7] for more information.
- credential.sanitizePrompt
-
By default, user names and hosts that are shown as part of the password prompt are not allowed to contain control characters (they will be URL-encoded by default). Configure this setting to
falseto override that behavior. - credential.protectProtocol
-
By default, Carriage Return characters are not allowed in the protocol that is used when Git talks to a credential helper. This setting allows users to override this default.
- credential.username
-
If no username is set for a network authentication, use this username by default. See credential.<context>.* below, and gitcredentials[7].
- credential.<url>.*
-
Any of the credential.* options above can be applied selectively to some credentials. For example, "credential.https://example.com.username" would set the default username only for https connections to example.com. See gitcredentials[7] for details on how URLs are matched.
- credentialCache.ignoreSIGHUP
-
Tell git-credential-cache—daemon to ignore SIGHUP, instead of quitting.
- credentialStore.lockTimeoutMS
-
The length of time, in milliseconds, for git-credential-store to retry when trying to lock the credentials file. A value of 0 means not to retry at all; -1 means to try indefinitely. Default is 1000 (i.e., retry for 1s).
diff.autoRefreshIndex-
When using
gitdiffto compare with work tree files, do not consider stat-only changes as changed. Instead, silently rungitupdate-index--refreshto update the cached stat information for paths whose contents in the work tree match the contents in the index. This option defaults totrue. Note that this affects onlygitdiffPorcelain, and not lower leveldiffcommands such asgitdiff-files. diff.dirstat-
A comma separated list of
--dirstatparameters specifying the default behavior of the--dirstatoption to git-diff[1] and friends. The defaults can be overridden on the command line (using--dirstat=<param>,...). The fallback defaults (when not changed bydiff.dirstat) arechanges,noncumulative,3. The following parameters are available:changes-
Compute the dirstat numbers by counting the lines that have been removed from the source, or added to the destination. This ignores the amount of pure code movements within a file. In other words, rearranging lines in a file is not counted as much as other changes. This is the default behavior when no parameter is given.
lines-
Compute the dirstat numbers by doing the regular line-based diff analysis, and summing the removed/added line counts. (For binary files, count 64-byte chunks instead, since binary files have no natural concept of lines). This is a more expensive
--dirstatbehavior than thechangesbehavior, but it does count rearranged lines within a file as much as other changes. The resulting output is consistent with what you get from the other--*statoptions. files-
Compute the dirstat numbers by counting the number of files changed. Each changed file counts equally in the dirstat analysis. This is the computationally cheapest
--dirstatbehavior, since it does not have to look at the file contents at all. cumulative-
Count changes in a child directory for the parent directory as well. Note that when using
cumulative, the sum of the percentages reported may exceed 100%. The default (non-cumulative) behavior can be specified with thenoncumulativeparameter. - <limit>
-
An integer parameter specifies a cut-off percent (3% by default). Directories contributing less than this percentage of the changes are not shown in the output.
Example: The following will count changed files, while ignoring directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories:
files,10,cumulative. diff.statNameWidth-
Limit the width of the filename part in
--statoutput. If set, applies to all commands generating--statoutput exceptformat-patch. diff.statGraphWidth-
Limit the width of the graph part in
--statoutput. If set, applies to all commands generating--statoutput exceptformat-patch. diff.context-
Generate diffs with <n> lines of context instead of the default of 3. This value is overridden by the
-Uoption. diff.interHunkContext-
Show the context between diff hunks, up to the specified number of lines, thereby fusing the hunks that are close to each other. This value serves as the default for the
--inter-hunk-contextcommand line option. diff.external-
If this config variable is set, diff generation is not performed using the internal diff machinery, but using the given command. Can be overridden with the
GIT_EXTERNAL_DIFFenvironment variable. The command is called with parameters as described under "git Diffs" in git[1]. Note: if you want to use an external diff program only on a subset of your files, you might want to use gitattributes[5] instead. diff.trustExitCode-
If this boolean value is set to
truethen thediff.externalcommand is expected to return exit code 0 if it considers the input files to be equal or 1 if it considers them to be different, likediff(1). If it is set tofalse, which is the default, then the command is expected to return exit code0regardless of equality. Any other exit code causes Git to report a fatal error. diff.ignoreSubmodules-
Sets the default value of
--ignore-submodules. Note that this affects onlygitdiffPorcelain, and not lower leveldiffcommands such asgitdiff-files.gitcheckoutandgitswitchalso honor this setting when reporting uncommitted changes. Setting it toalldisables the submodule summary normally shown bygitcommitandgitstatuswhenstatus.submoduleSummaryis set unless it is overridden by using the--ignore-submodulescommand-line option. Thegitsubmodulecommands are not affected by this setting. By default this is set to untracked so that any untracked submodules are ignored. diff.mnemonicPrefix-
If set,
gitdiffuses a prefix pair that is different from the standarda/andb/depending on what is being compared. When this configuration is in effect, reverse diff output also swaps the order of the prefixes:gitdiff-
compares the (i)ndex and the (w)ork tree;
gitdiffHEAD-
compares a (c)ommit and the (w)ork tree;
gitdiff--cached-
compares a (c)ommit and the (i)ndex;
gitdiffHEAD:<file1> <file2>-
compares an (o)bject and a (w)ork tree entity;
gitdiff--no-index<a> <b>-
compares two non-git things <a> and <b>.
diff.noPrefix-
If set,
gitdiffdoes not show any source or destination prefix. diff.srcPrefix-
If set,
gitdiffuses this source prefix. Defaults toa/. diff.dstPrefix-
If set,
gitdiffuses this destination prefix. Defaults tob/. diff.relative-
If set to
true,gitdiffdoes not show changes outside of the directory and show pathnames relative to the current directory. diff.orderFile-
File indicating how to order files within a diff. See the
-Ooption to git-diff[1] for details. Ifdiff.orderFileis a relative pathname, it is treated as relative to the top of the working tree. diff.renameLimit-
The number of files to consider in the exhaustive portion of copy/rename detection; equivalent to the
gitdiffoption-l. If not set, the default value is currently 1000. This setting has no effect if rename detection is turned off. diff.renames-
Whether and how Git detects renames. If set to
false, rename detection is disabled. If set totrue, basic rename detection is enabled. If set tocopiesorcopy, Git will detect copies, as well. Defaults totrue. Note that this affects onlygitdiffPorcelain like git-diff[1] and git-log[1], and not lower level commands such as git-diff-files[1]. diff.suppressBlankEmpty-
A boolean to inhibit the standard behavior of printing a space before each empty output line. Defaults to
false. diff.submodule-
Specify the format in which differences in submodules are shown. The
shortformat just shows the names of the commits at the beginning and end of the range. Thelogformat lists the commits in the range like git-submodule[1]summarydoes. Thediffformat shows an inline diff of the changed contents of the submodule. Defaults toshort. diff.wordRegex-
A POSIX Extended Regular Expression used to determine what is a "word" when performing word-by-word difference calculations. Character sequences that match the regular expression are "words", all other characters are ignorable whitespace.
diff.<driver>.command-
The custom diff driver command. See gitattributes[5] for details.
diff.<driver>.trustExitCode-
If this boolean value is set to
truethen thediff.<driver>.commandcommand is expected to return exit code 0 if it considers the input files to be equal or 1 if it considers them to be different, likediff(1). If it is set tofalse, which is the default, then the command is expected to return exit code 0 regardless of equality. Any other exit code causes Git to report a fatal error. diff.<driver>.xfuncname-
The regular expression that the diff driver should use to recognize the hunk header. A built-in pattern may also be used. See gitattributes[5] for details.
diff.<driver>.binary-
Set this option to
trueto make the diff driver treat files as binary. See gitattributes[5] for details. diff.<driver>.textconv-
The command that the diff driver should call to generate the text-converted version of a file. The result of the conversion is used to generate a human-readable diff. See gitattributes[5] for details.
diff.<driver>.wordRegex-
The regular expression that the diff driver should use to split words in a line. See gitattributes[5] for details.
diff.<driver>.cachetextconv-
Set this option to
trueto make the diff driver cache the text conversion outputs. See gitattributes[5] for details. diff.indentHeuristic-
Set this option to
falseto disable the default heuristics that shift diff hunk boundaries to make patches easier to read. diff.algorithm-
Choose a diff algorithm. The variants are as follows:
defaultmyers-
The basic greedy diff algorithm. Currently, this is the default.
minimal-
Spend extra time to make sure the smallest possible diff is produced.
patience-
Use "patience diff" algorithm when generating patches.
histogram-
This algorithm extends the patience algorithm to "support low-occurrence common elements".
diff.wsErrorHighlight-
Highlight whitespace errors in the
context,oldornewlines of the diff. Multiple values are separated by comma,noneresets previous values,defaultreset the list tonewandallis a shorthand forold,new,context. The whitespace errors are colored withcolor.diff.whitespace. The command line option--ws-error-highlight=<kind> overrides this setting. diff.colorMoved-
If set to either a valid <mode> or a
truevalue, moved lines in a diff are colored differently. For details of valid modes see--color-movedin git-diff[1]. If simply set totruethe default color mode will be used. When set tofalse, moved lines are not colored. diff.colorMovedWS-
When moved lines are colored using e.g. the
diff.colorMovedsetting, this option controls the mode how spaces are treated. For details of valid modes see--color-moved-wsin git-diff[1]. - diff.tool
-
Controls which diff tool is used by git-difftool[1]. This variable overrides the value configured in
merge.tool. The list below shows the valid built-in values. Any other value is treated as a custom diff tool and requires that a corresponding difftool.<tool>.cmd variable is defined. - diff.guitool
-
Controls which diff tool is used by git-difftool[1] when the -g/--gui flag is specified. This variable overrides the value configured in
merge.guitool. The list below shows the valid built-in values. Any other value is treated as a custom diff tool and requires that a corresponding difftool.<guitool>.cmd variable is defined.-
araxis
-
bc
-
codecompare
-
deltawalker
-
diffmerge
-
diffuse
-
ecmerge
-
emerge
-
examdiff
-
guiffy
-
gvimdiff
-
kdiff3
-
kompare
-
meld
-
nvimdiff
-
opendiff
-
p4merge
-
smerge
-
tkdiff
-
vimdiff
-
vscode
-
winmerge
-
xxdiff
-
- difftool.<tool>.cmd
-
Specify the command to invoke the specified diff tool. The specified command is evaluated in shell with the following variables available: LOCAL is set to the name of the temporary file containing the contents of the diff pre-image and REMOTE is set to the name of the temporary file containing the contents of the diff post-image.
See the
--tool=<tool> option in git-difftool[1] for more details. - difftool.<tool>.path
-
Override the path for the given tool. This is useful in case your tool is not in the PATH.
- difftool.trustExitCode
-
Exit difftool if the invoked diff tool returns a non-zero exit status.
See the
--trust-exit-codeoption in git-difftool[1] for more details. - difftool.prompt
-
Prompt before each invocation of the diff tool.
- difftool.guiDefault
-
Set
trueto use thediff.guitoolby default (equivalent to specifying the--guiargument), orautoto selectdiff.guitoolordiff.tooldepending on the presence of aDISPLAYenvironment variable value. The default isfalse, where the--guiargument must be provided explicitly for thediff.guitoolto be used. - extensions.*
-
Unless otherwise stated, is an error to specify an extension if
core.repositoryFormatVersionis not1. See gitrepository-layout[5].- compatObjectFormat
-
Specify a compatibility hash algorithm to use. The acceptable values are
sha1andsha256. The value specified must be different from the value ofextensions.objectFormat. This allows client level interoperability between git repositories whose objectFormat matches this compatObjectFormat. In particular when fully implemented the pushes and pulls from a repository in whose objectFormat matches compatObjectFormat. As well as being able to use oids encoded in compatObjectFormat in addition to oids encoded with objectFormat to locally specify objects.Note that the functionality enabled by this extension is incomplete and subject to change. It currently exists only to allow development and testing of the underlying feature and is not designed to be enabled by end users.
- noop
-
This extension does not change git’s behavior at all. It is useful only for testing format-1 compatibility.
For historical reasons, this extension is respected regardless of the
core.repositoryFormatVersionsetting. - noop-v1
-
This extension does not change git’s behavior at all. It is useful only for testing format-1 compatibility.
- objectFormat
-
Specify the hash algorithm to use. The acceptable values are
sha1andsha256. If not specified,sha1is assumed.Note that this setting should only be set by git-init[1] or git-clone[1]. Trying to change it after initialization will not work and will produce hard-to-diagnose issues.
- partialClone
-
When enabled, indicates that the repo was created with a partial clone (or later performed a partial fetch) and that the remote may have omitted sending certain unwanted objects. Such a remote is called a "promisor remote" and it promises that all such omitted objects can be fetched from it in the future.
The value of this key is the name of the promisor remote.
For historical reasons, this extension is respected regardless of the
core.repositoryFormatVersionsetting. - preciousObjects
-
If enabled, indicates that objects in the repository MUST NOT be deleted (e.g., by
git-pruneorgitrepack-d).For historical reasons, this extension is respected regardless of the
core.repositoryFormatVersionsetting. - refStorage
-
Specify the ref storage format to use. The acceptable values are:
-
filesfor loose files with packed-refs. This is the default. -
reftablefor the reftable format. This format is experimental and its internals are subject to change.
Note that this setting should only be set by git-init[1] or git-clone[1]. Trying to change it after initialization will not work and will produce hard-to-diagnose issues.
-
- relativeWorktrees
-
If enabled, indicates at least one worktree has been linked with relative paths. Automatically set if a worktree has been created or repaired with either the
--relative-pathsoption or with theworktree.useRelativePathsconfig set totrue. - worktreeConfig
-
If enabled, then worktrees will load config settings from the
$GIT_DIR/config.worktreefile in addition to the$GIT_COMMON_DIR/configfile. Note that$GIT_COMMON_DIRand$GIT_DIRare the same for the main working tree, while other working trees have$GIT_DIRequal to$GIT_COMMON_DIR/worktrees/<id>/. The settings in theconfig.worktreefile will override settings from any other config files.When enabling this extension, you must be careful to move certain values from the common config file to the main working tree’s
config.worktreefile, if present:-
core.worktreemust be moved from$GIT_COMMON_DIR/configto$GIT_COMMON_DIR/config.worktree. -
If
core.bareis true, then it must be moved from$GIT_COMMON_DIR/configto$GIT_COMMON_DIR/config.worktree.
It may also be beneficial to adjust the locations of
core.sparseCheckoutandcore.sparseCheckoutConedepending on your desire for customizable sparse-checkout settings for each worktree. By default, thegitsparse-checkoutbuiltin enables this extension, assigns these config values on a per-worktree basis, and uses the$GIT_DIR/info/sparse-checkoutfile to specify the sparsity for each worktree independently. See git-sparse-checkout[1] for more details.For historical reasons, this extension is respected regardless of the
core.repositoryFormatVersionsetting. -
- fastimport.unpackLimit
-
If the number of objects imported by git-fast-import[1] is below this limit, then the objects will be unpacked into loose object files. However, if the number of imported objects equals or exceeds this limit, then the pack will be stored as a pack. Storing the pack from a fast-import can make the import operation complete faster, especially on slow filesystems. If not set, the value of
transfer.unpackLimitis used instead. - feature.*
-
The config settings that start with
feature.modify the defaults of a group of other config settings. These groups are created by the Git developer community as recommended defaults and are subject to change. In particular, new config options may be added with different defaults. - feature.experimental
-
Enable config options that are new to Git, and are being considered for future defaults. Config settings included here may be added or removed with each release, including minor version updates. These settings may have unintended interactions since they are so new. Please enable this setting if you are interested in providing feedback on experimental features. The new default values are:
-
fetch.negotiationAlgorithm=skippingmay improve fetch negotiation times by skipping more commits at a time, reducing the number of round trips. -
pack.useBitmapBoundaryTraversal=truemay improve bitmap traversal times by walking fewer objects. -
pack.allowPackReuse=multimay improve the time it takes to create a pack by reusing objects from multiple packs instead of just one. -
pack.usePathWalkmay speed up packfile creation and make the packfiles be significantly smaller in the presence of certain filename collisions with Git’s default name-hash. -
init.defaultRefFormat=reftablecauses newly initialized repositories to use the reftable format for storing references. This new format solves issues with case-insensitive filesystems, compresses better and performs significantly better with many use cases. Refer to Documentation/technical/reftable.adoc for more information on this new storage format.
-
- feature.manyFiles
-
Enable config options that optimize for repos with many files in the working directory. With many files, commands such as
gitstatusandgitcheckoutmay be slow and these new defaults improve performance:-
index.skipHash=truespeeds up index writes by not computing a trailing checksum. Note that this will cause Git versions earlier than 2.13.0 to refuse to parse the index and Git versions earlier than 2.40.0 will report a corrupted index duringgitfsck. -
index.version=4enables path-prefix compression in the index. -
core.untrackedCache=trueenables the untracked cache. This setting assumes that mtime is working on your machine.
-
- fetch.recurseSubmodules
-
This option controls whether
gitfetch(and the underlying fetch ingitpull) will recursively fetch into populated submodules. This option can be set either to a boolean value or to on-demand. Setting it to a boolean changes the behavior of fetch and pull to recurse unconditionally into submodules when set to true or to not recurse at all when set to false. When set to on-demand, fetch and pull will only recurse into a populated submodule when its superproject retrieves a commit that updates the submodule’s reference. Defaults to on-demand, or to the value of submodule.recurse if set. - fetch.fsckObjects
-
If it is set to true, git-fetch-pack will check all fetched objects. See
transfer.fsckObjectsfor what’s checked. Defaults to false. If not set, the value oftransfer.fsckObjectsis used instead. - fetch.fsck.<msg-id>
-
Acts like
fsck.<msg-id>, but is used by git-fetch-pack[1] instead of git-fsck[1]. See thefsck.<msg-id> documentation for details. - fetch.fsck.skipList
-
Acts like
fsck.skipList, but is used by git-fetch-pack[1] instead of git-fsck[1]. See thefsck.skipListdocumentation for details. - fetch.unpackLimit
-
If the number of objects fetched over the Git native transfer is below this limit, then the objects will be unpacked into loose object files. However if the number of received objects equals or exceeds this limit then the received pack will be stored as a pack, after adding any missing delta bases. Storing the pack from a push can make the push operation complete faster, especially on slow filesystems. If not set, the value of
transfer.unpackLimitis used instead. - fetch.prune
-
If true, fetch will automatically behave as if the
--pruneoption was given on the command line. See alsoremote.<name>.pruneand the PRUNING section of git-fetch[1]. - fetch.pruneTags
-
If true, fetch will automatically behave as if the
refs/tags/*:refs/tags/*refspec was provided when pruning, if not set already. This allows for setting both this option andfetch.pruneto maintain a 1=1 mapping to upstream refs. See alsoremote.<name>.pruneTagsand the PRUNING section of git-fetch[1]. - fetch.all
-
If true, fetch will attempt to update all available remotes. This behavior can be overridden by passing
--no-allor by explicitly specifying one or more remote(s) to fetch from. Defaults to false. - fetch.output
-
Control how ref update status is printed. Valid values are
fullandcompact. Default value isfull. See the OUTPUT section in git-fetch[1] for details. - fetch.negotiationAlgorithm
-
Control how information about the commits in the local repository is sent when negotiating the contents of the packfile to be sent by the server. Set to "consecutive" to use an algorithm that walks over consecutive commits checking each one. Set to "skipping" to use an algorithm that skips commits in an effort to converge faster, but may result in a larger-than-necessary packfile; or set to "noop" to not send any information at all, which will almost certainly result in a larger-than-necessary packfile, but will skip the negotiation step. Set to "default" to override settings made previously and use the default behaviour. The default is normally "consecutive", but if
feature.experimentalis true, then the default is "skipping". Unknown values will cause git fetch to error out.See also the
--negotiate-onlyand--negotiation-tipoptions to git-fetch[1]. - fetch.showForcedUpdates
-
Set to false to enable
--no-show-forced-updatesin git-fetch[1] and git-pull[1] commands. Defaults to true. - fetch.parallel
-
Specifies the maximal number of fetch operations to be run in parallel at a time (submodules, or remotes when the
--multipleoption of git-fetch[1] is in effect).A value of 0 will give some reasonable default. If unset, it defaults to 1.
For submodules, this setting can be overridden using the
submodule.fetchJobsconfig setting. - fetch.writeCommitGraph
-
Set to true to write a commit-graph after every
gitfetchcommand that downloads a pack-file from a remote. Using the--splitoption, most executions will create a very small commit-graph file on top of the existing commit-graph file(s). Occasionally, these files will merge and the write may take longer. Having an updated commit-graph file helps performance of many Git commands, includinggitmerge-base,gitpush-f, andgitlog--graph. Defaults to false. - fetch.bundleURI
-
This value stores a URI for downloading Git object data from a bundle URI before performing an incremental fetch from the origin Git server. This is similar to how the
--bundle-urioption behaves in git-clone[1].gitclone--bundle-uriwill set thefetch.bundleURIvalue if the supplied bundle URI contains a bundle list that is organized for incremental fetches.If you modify this value and your repository has a
fetch.bundleCreationTokenvalue, then remove thatfetch.bundleCreationTokenvalue before fetching from the new bundle URI. - fetch.bundleCreationToken
-
When using
fetch.bundleURIto fetch incrementally from a bundle list that uses the "creationToken" heuristic, this config value stores the maximumcreationTokenvalue of the downloaded bundles. This value is used to prevent downloading bundles in the future if the advertisedcreationTokenis not strictly larger than this value.The creation token values are chosen by the provider serving the specific bundle URI. If you modify the URI at
fetch.bundleURI, then be sure to remove the value for thefetch.bundleCreationTokenvalue before fetching. - filter.<driver>.clean
-
The command which is used to convert the content of a worktree file to a blob upon checkin. See gitattributes[5] for details.
- filter.<driver>.smudge
-
The command which is used to convert the content of a blob object to a worktree file upon checkout. See gitattributes[5] for details.
- format.attach
-
Enable multipart/mixed attachments as the default for format-patch. The value can also be a double quoted string which will enable attachments as the default and set the value as the boundary. See the --attach option in git-format-patch[1]. To countermand an earlier value, set it to an empty string.
- format.from
-
Provides the default value for the
--fromoption to format-patch. Accepts a boolean value, or a name and email address. If false, format-patch defaults to--no-from, using commit authors directly in the "From:" field of patch mails. If true, format-patch defaults to--from, using your committer identity in the "From:" field of patch mails and including a "From:" field in the body of the patch mail if different. If set to a non-boolean value, format-patch uses that value instead of your committer identity. Defaults to false. - format.forceInBodyFrom
-
Provides the default value for the
--[no-]force-in-body-fromoption to format-patch. Defaults to false. - format.numbered
-
A boolean which can enable or disable sequence numbers in patch subjects. It defaults to "auto" which enables it only if there is more than one patch. It can be enabled or disabled for all messages by setting it to "true" or "false". See --numbered option in git-format-patch[1].
- format.headers
-
Additional email headers to include in a patch to be submitted by mail. See git-format-patch[1].
- format.to
- format.cc
-
Additional recipients to include in a patch to be submitted by mail. See the --to and --cc options in git-format-patch[1].
- format.subjectPrefix
-
The default for format-patch is to output files with the [PATCH] subject prefix. Use this variable to change that prefix.
- format.coverFromDescription
-
The default mode for format-patch to determine which parts of the cover letter will be populated using the branch’s description. See the
--cover-from-descriptionoption in git-format-patch[1]. - format.signature
-
The default for format-patch is to output a signature containing the Git version number. Use this variable to change that default. Set this variable to the empty string ("") to suppress signature generation.
- format.signatureFile
-
Works just like format.signature except the contents of the file specified by this variable will be used as the signature.
- format.suffix
-
The default for format-patch is to output files with the suffix
.patch. Use this variable to change that suffix (make sure to include the dot if you want it). - format.encodeEmailHeaders
-
Encode email headers that have non-ASCII characters with "Q-encoding" (described in RFC 2047) for email transmission. Defaults to true.
- format.pretty
-
The default pretty format for log/show/whatchanged command. See git-log[1], git-show[1], git-whatchanged[1].
- format.thread
-
The default threading style for git format-patch. Can be a boolean value, or
shallowordeep.shallowthreading makes every mail a reply to the head of the series, where the head is chosen from the cover letter, the--in-reply-to, and the first patch mail, in this order.deepthreading makes every mail a reply to the previous one. A true boolean value is the same asshallow, and a false value disables threading. - format.signOff
-
A boolean value which lets you enable the
-s/--signoffoption of format-patch by default. Note: Adding theSigned-off-bytrailer to a patch should be a conscious act and means that you certify you have the rights to submit this work under the same open source license. Please see the SubmittingPatches document for further discussion. - format.coverLetter
-
A boolean that controls whether to generate a cover-letter when format-patch is invoked, but in addition can be set to "auto", to generate a cover-letter only when there’s more than one patch. Default is false.
- format.outputDirectory
-
Set a custom directory to store the resulting files instead of the current working directory. All directory components will be created.
- format.filenameMaxLength
-
The maximum length of the output filenames generated by the
format-patchcommand; defaults to 64. Can be overridden by the--filename-max-length=<n> command line option. - format.useAutoBase
-
A boolean value which lets you enable the
--base=autooption of format-patch by default. Can also be set to "whenAble" to allow enabling--base=autoif a suitable base is available, but to skip adding base info otherwise without the format dying. - format.notes
-
Provides the default value for the
--notesoption to format-patch. Accepts a boolean value, or a ref which specifies where to get notes. If false, format-patch defaults to--no-notes. If true, format-patch defaults to--notes. If set to a non-boolean value, format-patch defaults to--notes=<ref>, whererefis the non-boolean value. Defaults to false.If one wishes to use the ref
refs/notes/true, please use that literal instead.This configuration can be specified multiple times in order to allow multiple notes refs to be included. In that case, it will behave similarly to multiple
--[no-]notes[=] options passed in. That is, a value oftruewill show the default notes, a value of <ref> will also show notes from that notes ref and a value offalsewill negate previous configurations and not show notes.For example,
[format] notes = true notes = foo notes = false notes = bar
will only show notes from
refs/notes/bar. - format.mboxrd
-
A boolean value which enables the robust "mboxrd" format when
--stdoutis in use to escape "^>+From " lines. - format.noprefix
-
If set, do not show any source or destination prefix in patches. This is equivalent to the
diff.noprefixoption used bygitdiff(but which is not respected byformat-patch). Note that by setting this, the receiver of any patches you generate will have to apply them using the-p0option. - fsck.<msg-id>
-
During fsck git may find issues with legacy data which wouldn’t be generated by current versions of git, and which wouldn’t be sent over the wire if
transfer.fsckObjectswas set. This feature is intended to support working with legacy repositories containing such data.Setting
fsck.<msg-id> will be picked up by git-fsck[1], but to accept pushes of such data setreceive.fsck.<msg-id> instead, or to clone or fetch it setfetch.fsck.<msg-id>.The rest of the documentation discusses
fsck.*for brevity, but the same applies for the correspondingreceive.fsck.*andfetch.fsck.*. variables.Unlike variables like
color.uiandcore.editor, thereceive.fsck.<msg-id> andfetch.fsck.<msg-id> variables will not fall back on thefsck.<msg-id> configuration if they aren’t set. To uniformly configure the same fsck settings in different circumstances, all three of them must be set to the same values.When
fsck.<msg-id> is set, errors can be switched to warnings and vice versa by configuring thefsck.<msg-id> setting where the <msg-id> is the fsck message ID and the value is one oferror,warnorignore. For convenience, fsck prefixes the error/warning with the message ID, e.g. "missingEmail: invalid author/committer line - missing email" means that settingfsck.missingEmail=ignorewill hide that issue.In general, it is better to enumerate existing objects with problems with
fsck.skipList, instead of listing the kind of breakages these problematic objects share to be ignored, as doing the latter will allow new instances of the same breakages go unnoticed.Setting an unknown
fsck.<msg-id> value will cause fsck to die, but doing the same forreceive.fsck.<msg-id> andfetch.fsck.<msg-id> will only cause git to warn.See the
FsckMessagessection of git-fsck[1] for supported values of <msg-id>. - fsck.skipList
-
The path to a list of object names (i.e. one unabbreviated SHA-1 per line) that are known to be broken in a non-fatal way and should be ignored. On versions of Git 2.20 and later, comments (#), empty lines, and any leading and trailing whitespace are ignored. Everything but a SHA-1 per line will error out on older versions.
This feature is useful when an established project should be accepted despite early commits containing errors that can be safely ignored, such as invalid committer email addresses. Note: corrupt objects cannot be skipped with this setting.
Like
fsck.<msg-id> this variable has correspondingreceive.fsck.skipListandfetch.fsck.skipListvariants.Unlike variables like
color.uiandcore.editorthereceive.fsck.skipListandfetch.fsck.skipListvariables will not fall back on thefsck.skipListconfiguration if they aren’t set. To uniformly configure the same fsck settings in different circumstances, all three of them must be set to the same values.Older versions of Git (before 2.20) documented that the object names list should be sorted. This was never a requirement; the object names could appear in any order, but when reading the list we tracked whether the list was sorted for the purposes of an internal binary search implementation, which could save itself some work with an already sorted list. Unless you had a humongous list there was no reason to go out of your way to pre-sort the list. After Git version 2.20 a hash implementation is used instead, so there’s now no reason to pre-sort the list.
- fsmonitor.allowRemote
-
By default, the fsmonitor daemon refuses to work with network-mounted repositories. Setting
fsmonitor.allowRemotetotrueoverrides this behavior. Only respected whencore.fsmonitoris set totrue. - fsmonitor.socketDir
-
This Mac OS-specific option, if set, specifies the directory in which to create the Unix domain socket used for communication between the fsmonitor daemon and various Git commands. The directory must reside on a native Mac OS filesystem. Only respected when
core.fsmonitoris set totrue. - gc.aggressiveDepth
-
The depth parameter used in the delta compression algorithm used by git gc --aggressive. This defaults to 50, which is the default for the
--depthoption when--aggressiveisn’t in use.See the documentation for the
--depthoption in git-repack[1] for more details. - gc.aggressiveWindow
-
The window size parameter used in the delta compression algorithm used by git gc --aggressive. This defaults to 250, which is a much more aggressive window size than the default
--windowof 10.See the documentation for the
--windowoption in git-repack[1] for more details. - gc.auto
-
When there are approximately more than this many loose objects in the repository,
gitgc--autowill pack them. Some Porcelain commands use this command to perform a light-weight garbage collection from time to time. The default value is 6700.Setting this to 0 disables not only automatic packing based on the number of loose objects, but also any other heuristic
gitgc--autowill otherwise use to determine if there’s work to do, such asgc.autoPackLimit. - gc.autoPackLimit
-
When there are more than this many packs that are not marked with
*.keepfile in the repository,gitgc--autoconsolidates them into one larger pack. The default value is 50. Setting this to 0 disables it. Settinggc.autoto 0 will also disable this.See the
gc.bigPackThresholdconfiguration variable below. When in use, it’ll affect how the auto pack limit works. - gc.autoDetach
-
Make
gitgc--autoreturn immediately and run in the background if the system supports it. Default is true. This config variable acts as a fallback in casemaintenance.autoDetachis not set. - gc.bigPackThreshold
-
If non-zero, all non-cruft packs larger than this limit are kept when
gitgcis run. This is very similar to--keep-largest-packexcept that all non-cruft packs that meet the threshold are kept, not just the largest pack. Defaults to zero. Common unit suffixes of k, m, or g are supported.Note that if the number of kept packs is more than gc.autoPackLimit, this configuration variable is ignored, all packs except the base pack will be repacked. After this the number of packs should go below gc.autoPackLimit and gc.bigPackThreshold should be respected again.
If the amount of memory estimated for
gitrepackto run smoothly is not available andgc.bigPackThresholdis not set, the largest pack will also be excluded (this is the equivalent of runninggitgcwith--keep-largest-pack). - gc.writeCommitGraph
-
If true, then gc will rewrite the commit-graph file when git-gc[1] is run. When using
gitgc--autothe commit-graph will be updated if housekeeping is required. Default is true. See git-commit-graph[1] for details. - gc.logExpiry
-
If the file gc.log exists, then
gitgc--autowill print its content and exit with status zero instead of running unless that file is more than gc.logExpiry old. Default is "1.day". Seegc.pruneExpirefor more ways to specify its value. - gc.packRefs
-
Running
gitpack-refsin a repository renders it unclonable by Git versions prior to 1.5.1.2 over dumb transports such as HTTP. This variable determines whether git gc runsgitpack-refs. This can be set tonotbareto enable it within all non-bare repos or it can be set to a boolean value. The default istrue. - gc.cruftPacks
-
Store unreachable objects in a cruft pack (see git-repack[1]) instead of as loose objects. The default is
true. - gc.maxCruftSize
-
Limit the size of new cruft packs when repacking. When specified in addition to
--max-cruft-size, the command line option takes priority. See the--max-cruft-sizeoption of git-repack[1]. - gc.pruneExpire
-
When git gc is run, it will call prune --expire 2.weeks.ago (and repack --cruft --cruft-expiration 2.weeks.ago if using cruft packs via
gc.cruftPacksor--cruft). Override the grace period with this config variable. The value "now" may be used to disable this grace period and always prune unreachable objects immediately, or "never" may be used to suppress pruning. This feature helps prevent corruption when git gc runs concurrently with another process writing to the repository; see the "NOTES" section of git-gc[1]. - gc.worktreePruneExpire
-
When git gc is run, it calls git worktree prune --expire 3.months.ago. This config variable can be used to set a different grace period. The value "now" may be used to disable the grace period and prune
$GIT_DIR/worktreesimmediately, or "never" may be used to suppress pruning. - gc.reflogExpire
- gc.<pattern>.reflogExpire
-
git reflog expire removes reflog entries older than this time; defaults to 90 days. The value "now" expires all entries immediately, and "never" suppresses expiration altogether. With "<pattern>" (e.g. "refs/stash") in the middle the setting applies only to the refs that match the <pattern>.
- gc.reflogExpireUnreachable
- gc.<pattern>.reflogExpireUnreachable
-
git reflog expire removes reflog entries older than this time and are not reachable from the current tip; defaults to 30 days. The value "now" expires all entries immediately, and "never" suppresses expiration altogether. With "<pattern>" (e.g. "refs/stash") in the middle, the setting applies only to the refs that match the <pattern>.
These types of entries are generally created as a result of using
gitcommit--amendorgitrebaseand are the commits prior to the amend or rebase occurring. Since these changes are not part of the current project most users will want to expire them sooner, which is why the default is more aggressive thangc.reflogExpire. - gc.recentObjectsHook
-
When considering whether or not to remove an object (either when generating a cruft pack or storing unreachable objects as loose), use the shell to execute the specified command(s). Interpret their output as object IDs which Git will consider as "recent", regardless of their age. By treating their mtimes as "now", any objects (and their descendants) mentioned in the output will be kept regardless of their true age.
Output must contain exactly one hex object ID per line, and nothing else. Objects which cannot be found in the repository are ignored. Multiple hooks are supported, but all must exit successfully, else the operation (either generating a cruft pack or unpacking unreachable objects) will be halted.
- gc.repackFilter
-
When repacking, use the specified filter to move certain objects into a separate packfile. See the
--filter=<filter-spec> option of git-repack[1]. - gc.repackFilterTo
-
When repacking and using a filter, see
gc.repackFilter, the specified location will be used to create the packfile containing the filtered out objects. WARNING: The specified location should be accessible, using for example the Git alternates mechanism, otherwise the repo could be considered corrupt by Git as it might not be able to access the objects in that packfile. See the--filter-to=<dir> option of git-repack[1] and theobjects/info/alternatessection of gitrepository-layout[5]. - gc.rerereResolved
-
Records of conflicted merge you resolved earlier are kept for this many days when git rerere gc is run. You can also use more human-readable "1.month.ago", etc. The default is 60 days. See git-rerere[1].
- gc.rerereUnresolved
-
Records of conflicted merge you have not resolved are kept for this many days when git rerere gc is run. You can also use more human-readable "1.month.ago", etc. The default is 15 days. See git-rerere[1].
- gitcvs.commitMsgAnnotation
-
Append this string to each commit message. Set to empty string to disable this feature. Defaults to "via git-CVS emulator".
- gitcvs.enabled
-
Whether the CVS server interface is enabled for this repository. See git-cvsserver[1].
- gitcvs.logFile
-
Path to a log file where the CVS server interface well… logs various stuff. See git-cvsserver[1].
- gitcvs.usecrlfattr
-
If true, the server will look up the end-of-line conversion attributes for files to determine the
-kmodes to use. If the attributes force Git to treat a file as text, the-kmode will be left blank so CVS clients will treat it as text. If they suppress text conversion, the file will be set with -kb mode, which suppresses any newline munging the client might otherwise do. If the attributes do not allow the file type to be determined, thengitcvs.allBinaryis used. See gitattributes[5]. - gitcvs.allBinary
-
This is used if
gitcvs.usecrlfattrdoes not resolve the correct -kb mode to use. If true, all unresolved files are sent to the client in mode -kb. This causes the client to treat them as binary files, which suppresses any newline munging it otherwise might do. Alternatively, if it is set to "guess", then the contents of the file are examined to decide if it is binary, similar tocore.autocrlf. - gitcvs.dbName
-
Database used by git-cvsserver to cache revision information derived from the Git repository. The exact meaning depends on the used database driver, for SQLite (which is the default driver) this is a filename. Supports variable substitution (see git-cvsserver[1] for details). May not contain semicolons (;). Default: %Ggitcvs.%m.sqlite
- gitcvs.dbDriver
-
Used Perl DBI driver. You can specify any available driver for this here, but it might not work. git-cvsserver is tested with DBD::SQLite, reported to work with DBD::Pg, and reported not to work with DBD::mysql. Experimental feature. May not contain double colons (
:). Default: SQLite. See git-cvsserver[1]. - gitcvs.dbUser
- gitcvs.dbPass
-
Database user and password. Only useful if setting
gitcvs.dbDriver, since SQLite has no concept of database users and/or passwords. gitcvs.dbUser supports variable substitution (see git-cvsserver[1] for details). - gitcvs.dbTableNamePrefix
-
Database table name prefix. Prepended to the names of any database tables used, allowing a single database to be used for several repositories. Supports variable substitution (see git-cvsserver[1] for details). Any non-alphabetic characters will be replaced with underscores.
All gitcvs variables except for gitcvs.usecrlfattr and
gitcvs.allBinary can also be specified as
gitcvs.<access_method>.<varname> (where access_method
is one of "ext" and "pserver") to make them apply only for the given
access method.
- gitweb.category
- gitweb.description
- gitweb.owner
- gitweb.url
-
See gitweb[1] for description.
- gitweb.avatar
- gitweb.blame
- gitweb.grep
- gitweb.highlight
- gitweb.patches
- gitweb.pickaxe
- gitweb.remote_heads
- gitweb.showSizes
- gitweb.snapshot
-
See gitweb.conf[5] for description.
- gpg.program
-
Pathname of the program to use instead of "
gpg" when making or verifying a PGP signature. The program must support the same command-line interface as GPG, namely, to verify a detached signature, "gpg --verify $signature - <$file" is run, and the program is expected to signal a good signature by exiting with code 0. To generate an ASCII-armored detached signature, the standard input of "gpg-bsau$key" is fed with the contents to be signed, and the program is expected to send the result to its standard output. - gpg.format
-
Specifies which key format to use when signing with
--gpg-sign. Default is "openpgp". Other possible values are "x509", "ssh".See gitformat-signature[5] for the signature format, which differs based on the selected
gpg.format. - gpg.<format>.program
-
Use this to customize the program used for the signing format you chose. (see
gpg.programandgpg.format)gpg.programcan still be used as a legacy synonym forgpg.openpgp.program. The default value forgpg.x509.programis "gpgsm" andgpg.ssh.programis "ssh-keygen". - gpg.minTrustLevel
-
Specifies a minimum trust level for signature verification. If this option is unset, then signature verification for merge operations requires a key with at least
marginaltrust. Other operations that perform signature verification require a key with at leastundefinedtrust. Setting this option overrides the required trust-level for all operations. Supported values, in increasing order of significance:-
undefined -
never -
marginal -
fully -
ultimate
-
- gpg.ssh.defaultKeyCommand
-
This command will be run when user.signingkey is not set and a ssh signature is requested. On successful exit a valid ssh public key prefixed with
key::is expected in the first line of its output. This allows for a script doing a dynamic lookup of the correct public key when it is impractical to statically configureuser.signingKey. For example when keys or SSH Certificates are rotated frequently or selection of the right key depends on external factors unknown to git. - gpg.ssh.allowedSignersFile
-
A file containing ssh public keys which you are willing to trust. The file consists of one or more lines of principals followed by an ssh public key. e.g.:
user1@example.com,user2@example.comssh-rsaAAAAX1...See ssh-keygen(1) "ALLOWED SIGNERS" for details. The principal is only used to identify the key and is available when verifying a signature.SSH has no concept of trust levels like gpg does. To be able to differentiate between valid signatures and trusted signatures the trust level of a signature verification is set to
fullywhen the public key is present in the allowedSignersFile. Otherwise the trust level isundefinedand git verify-commit/tag will fail.This file can be set to a location outside of the repository and every developer maintains their own trust store. A central repository server could generate this file automatically from ssh keys with push access to verify the code against. In a corporate setting this file is probably generated at a global location from automation that already handles developer ssh keys.
A repository that only allows signed commits can store the file in the repository itself using a path relative to the top-level of the working tree. This way only committers with an already valid key can add or change keys in the keyring.
Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after & valid-before options. Git will mark signatures as valid if the signing key was valid at the time of the signature’s creation. This allows users to change a signing key without invalidating all previously made signatures.
Using a SSH CA key with the cert-authority option (see ssh-keygen(1) "CERTIFICATES") is also valid.
- gpg.ssh.revocationFile
-
Either a SSH KRL or a list of revoked public keys (without the principal prefix). See ssh-keygen(1) for details. If a public key is found in this file then it will always be treated as having trust level "never" and signatures will show as invalid.
- grep.lineNumber
-
If set to true, enable
-noption by default. - grep.column
-
If set to true, enable the
--columnoption by default. - grep.patternType
-
Set the default matching behavior. Using a value of basic, extended, fixed, or perl will enable the
--basic-regexp,--extended-regexp,--fixed-strings, or--perl-regexpoption accordingly, while the value default will use thegrep.extendedRegexpoption to choose between basic and extended. - grep.extendedRegexp
-
If set to true, enable
--extended-regexpoption by default. This option is ignored when thegrep.patternTypeoption is set to a value other than default. - grep.threads
-
Number of grep worker threads to use. If unset (or set to 0), Git will use as many threads as the number of logical cores available.
- grep.fullName
-
If set to true, enable
--full-nameoption by default. - grep.fallbackToNoIndex
-
If set to true, fall back to
gitgrep--no-indexifgitgrepis executed outside of a git repository. Defaults to false. - gui.commitMsgWidth
-
Defines how wide the commit message window is in the git-gui[1]. "75" is the default.
- gui.diffContext
-
Specifies how many context lines should be used in calls to diff made by the git-gui[1]. The default is "5".
- gui.displayUntracked
-
Determines if git-gui[1] shows untracked files in the file list. The default is "true".
- gui.encoding
-
Specifies the default character encoding to use for displaying of file contents in git-gui[1] and gitk[1]. It can be overridden by setting the encoding attribute for relevant files (see gitattributes[5]). If this option is not set, the tools default to the locale encoding.
- gui.matchTrackingBranch
-
Determines if new branches created with git-gui[1] should default to tracking remote branches with matching names or not. Default: "false".
- gui.newBranchTemplate
-
Is used as a suggested name when creating new branches using the git-gui[1].
- gui.pruneDuringFetch
-
"true" if git-gui[1] should prune remote-tracking branches when performing a fetch. The default value is "false".
- gui.trustmtime
-
Determines if git-gui[1] should trust the file modification timestamp or not. By default the timestamps are not trusted.
- gui.spellingDictionary
-
Specifies the dictionary used for spell checking commit messages in the git-gui[1]. When set to "none" spell checking is turned off.
- gui.fastCopyBlame
-
If true, git gui blame uses
-Cinstead of-C-Cfor original location detection. It makes blame significantly faster on huge repositories at the expense of less thorough copy detection. - gui.copyBlameThreshold
-
Specifies the threshold to use in git gui blame original location detection, measured in alphanumeric characters. See the git-blame[1] manual for more information on copy detection.
- gui.blamehistoryctx
-
Specifies the radius of history context in days to show in gitk[1] for the selected commit, when the
ShowHistoryContextmenu item is invoked from git gui blame. If this variable is set to zero, the whole history is shown. - guitool.<name>.cmd
-
Specifies the shell command line to execute when the corresponding item of the git-gui[1]
Toolsmenu is invoked. This option is mandatory for every tool. The command is executed from the root of the working directory, and in the environment it receives the name of the tool asGIT_GUITOOL, the name of the currently selected file as FILENAME, and the name of the current branch as CUR_BRANCH (if the head is detached, CUR_BRANCH is empty). - guitool.<name>.needsFile
-
Run the tool only if a diff is selected in the GUI. It guarantees that FILENAME is not empty.
- guitool.<name>.noConsole
-
Run the command silently, without creating a window to display its output.
- guitool.<name>.noRescan
-
Don’t rescan the working directory for changes after the tool finishes execution.
- guitool.<name>.confirm
-
Show a confirmation dialog before actually running the tool.
- guitool.<name>.argPrompt
-
Request a string argument from the user, and pass it to the tool through the
ARGSenvironment variable. Since requesting an argument implies confirmation, the confirm option has no effect if this is enabled. If the option is set to true, yes, or 1, the dialog uses a built-in generic prompt; otherwise the exact value of the variable is used. - guitool.<name>.revPrompt
-
Request a single valid revision from the user, and set the
REVISIONenvironment variable. In other aspects this option is similar to argPrompt, and can be used together with it. - guitool.<name>.revUnmerged
-
Show only unmerged branches in the revPrompt subdialog. This is useful for tools similar to merge or rebase, but not for things like checkout or reset.
- guitool.<name>.title
-
Specifies the title to use for the prompt dialog. The default is the tool name.
- guitool.<name>.prompt
-
Specifies the general prompt string to display at the top of the dialog, before subsections for argPrompt and revPrompt. The default value includes the actual command.
- help.browser
-
Specify the browser that will be used to display help in the web format. See git-help[1].
- help.format
-
Override the default help format used by git-help[1]. Values man, info, web and html are supported. man is the default. web and html are the same.
- help.autoCorrect
-
If git detects typos and can identify exactly one valid command similar to the error, git will try to suggest the correct command or even run the suggestion automatically. Possible config values are:
-
0, "false", "off", "no", "show": show the suggested command (default).
-
1, "true", "on", "yes", "immediate": run the suggested command immediately.
-
positive number > 1: run the suggested command after specified deciseconds (0.1 sec).
-
"never": don’t run or show any suggested command.
-
"prompt": show the suggestion and prompt for confirmation to run the command.
-
- help.htmlPath
-
Specify the path where the HTML documentation resides. File system paths and URLs are supported. HTML pages will be prefixed with this path when help is displayed in the web format. This defaults to the documentation path of your Git installation.
- http.proxy
-
Override the HTTP proxy, normally configured using the http_proxy, https_proxy, and all_proxy environment variables (see
curl(1)). In addition to the syntax understood by curl, it is possible to specify a proxy string with a user name but no password, in which case git will attempt to acquire one in the same way it does for other credentials. See gitcredentials[7] for more information. The syntax thus is [protocol://][user[:password]@]proxyhost[:port][/path]. This can be overridden on a per-remote basis; see remote.<name>.proxyAny proxy, however configured, must be completely transparent and must not modify, transform, or buffer the request or response in any way. Proxies which are not completely transparent are known to cause various forms of breakage with Git.
- http.proxyAuthMethod
-
Set the method with which to authenticate against the HTTP proxy. This only takes effect if the configured proxy string contains a user name part (i.e. is of the form user@host or user@host:port). This can be overridden on a per-remote basis; see
remote.<name>.proxyAuthMethod. Both can be overridden by theGIT_HTTP_PROXY_AUTHMETHODenvironment variable. Possible values are:-
anyauth- Automatically pick a suitable authentication method. It is assumed that the proxy answers an unauthenticated request with a 407 status code and one or more Proxy-authenticate headers with supported authentication methods. This is the default. -
basic- HTTP Basic authentication -
digest- HTTP Digest authentication; this prevents the password from being transmitted to the proxy in clear text -
negotiate- GSS-Negotiate authentication (compare the --negotiate option ofcurl(1)) -
ntlm- NTLM authentication (compare the --ntlm option ofcurl(1))
-
- http.proxySSLCert
-
The pathname of a file that stores a client certificate to use to authenticate with an HTTPS proxy. Can be overridden by the
GIT_PROXY_SSL_CERTenvironment variable. - http.proxySSLKey
-
The pathname of a file that stores a private key to use to authenticate with an HTTPS proxy. Can be overridden by the
GIT_PROXY_SSL_KEYenvironment variable. - http.proxySSLCertPasswordProtected
-
Enable Git’s password prompt for the proxy SSL certificate. Otherwise OpenSSL will prompt the user, possibly many times, if the certificate or private key is encrypted. Can be overridden by the
GIT_PROXY_SSL_CERT_PASSWORD_PROTECTEDenvironment variable. - http.proxySSLCAInfo
-
Pathname to the file containing the certificate bundle that should be used to verify the proxy with when using an HTTPS proxy. Can be overridden by the
GIT_PROXY_SSL_CAINFOenvironment variable. - http.emptyAuth
-
Attempt authentication without seeking a username or password. This can be used to attempt GSS-Negotiate authentication without specifying a username in the URL, as libcurl normally requires a username for authentication.
- http.proactiveAuth
-
Attempt authentication without first making an unauthenticated attempt and receiving a 401 response. This can be used to ensure that all requests are authenticated. If
http.emptyAuthis set to true, this value has no effect.If the credential helper used specifies an authentication scheme (i.e., via the
authtypefield), that value will be used; if a username and password is provided without a scheme, then Basic authentication is used. The value of the option determines the scheme requested from the helper. Possible values are:-
basic- Request Basic authentication from the helper. -
auto- Allow the helper to pick an appropriate scheme. -
none- Disable proactive authentication.
Note that TLS should always be used with this configuration, since otherwise it is easy to accidentally expose plaintext credentials if Basic authentication is selected.
-
- http.delegation
-
Control GSSAPI credential delegation. The delegation is disabled by default in libcurl since version 7.21.7. Set parameter to tell the server what it is allowed to delegate when it comes to user credentials. Used with GSS/kerberos. Possible values are:
-
none- Don’t allow any delegation. -
policy- Delegates if and only if the OK-AS-DELEGATE flag is set in the Kerberos service ticket, which is a matter of realm policy. -
always- Unconditionally allow the server to delegate.
-
- http.extraHeader
-
Pass an additional HTTP header when communicating with a server. If more than one such entry exists, all of them are added as extra headers. To allow overriding the settings inherited from the system config, an empty value will reset the extra headers to the empty list.
- http.cookieFile
-
The pathname of a file containing previously stored cookie lines, which should be used in the Git http session, if they match the server. The file format of the file to read cookies from should be plain HTTP headers or the Netscape/Mozilla cookie file format (see
curl(1)). Set it to an empty string, to accept only new cookies from the server and send them back in successive requests within same connection. NOTE that the file specified with http.cookieFile is used only as input unless http.saveCookies is set. - http.saveCookies
-
If set, store cookies received during requests to the file specified by http.cookieFile. Has no effect if http.cookieFile is unset, or set to an empty string.
- http.version
-
Use the specified HTTP protocol version when communicating with a server. If you want to force the default. The available and default version depend on libcurl. Currently the possible values of this option are:
-
HTTP/2
-
HTTP/1.1
-
- http.curloptResolve
-
Hostname resolution information that will be used first by libcurl when sending HTTP requests. This information should be in one of the following formats:
-
[+]HOST:PORT:ADDRESS[,ADDRESS]
-
-HOST:PORT
The first format redirects all requests to the given
HOST:PORTto the providedADDRESS(s). The second format clears all previous config values for thatHOST:PORTcombination. To allow easy overriding of all the settings inherited from the system config, an empty value will reset all resolution information to the empty list. -
- http.sslVersion
-
The SSL version to use when negotiating an SSL connection, if you want to force the default. The available and default version depend on whether libcurl was built against NSS or OpenSSL and the particular configuration of the crypto library in use. Internally this sets the CURLOPT_SSL_VERSION option; see the libcurl documentation for more details on the format of this option and for the ssl version supported. Currently the possible values of this option are:
-
sslv2
-
sslv3
-
tlsv1
-
tlsv1.0
-
tlsv1.1
-
tlsv1.2
-
tlsv1.3
Can be overridden by the
GIT_SSL_VERSIONenvironment variable. To force git to use libcurl’s default ssl version and ignore any explicit http.sslversion option, setGIT_SSL_VERSIONto the empty string. -
- http.sslCipherList
-
A list of SSL ciphers to use when negotiating an SSL connection. The available ciphers depend on whether libcurl was built against NSS or OpenSSL and the particular configuration of the crypto library in use. Internally this sets the CURLOPT_SSL_CIPHER_LIST option; see the libcurl documentation for more details on the format of this list.
Can be overridden by the
GIT_SSL_CIPHER_LISTenvironment variable. To force git to use libcurl’s default cipher list and ignore any explicit http.sslCipherList option, setGIT_SSL_CIPHER_LISTto the empty string. - http.sslVerify
-
Whether to verify the SSL certificate when fetching or pushing over HTTPS. Defaults to true. Can be overridden by the
GIT_SSL_NO_VERIFYenvironment variable. - http.sslCert
-
File containing the SSL certificate when fetching or pushing over HTTPS. Can be overridden by the
GIT_SSL_CERTenvironment variable. - http.sslKey
-
File containing the SSL private key when fetching or pushing over HTTPS. Can be overridden by the
GIT_SSL_KEYenvironment variable. - http.sslCertPasswordProtected
-
Enable Git’s password prompt for the SSL certificate. Otherwise OpenSSL will prompt the user, possibly many times, if the certificate or private key is encrypted. Can be overridden by the
GIT_SSL_CERT_PASSWORD_PROTECTEDenvironment variable. - http.sslCAInfo
-
File containing the certificates to verify the peer with when fetching or pushing over HTTPS. Can be overridden by the
GIT_SSL_CAINFOenvironment variable. - http.sslCAPath
-
Path containing files with the CA certificates to verify the peer with when fetching or pushing over HTTPS. Can be overridden by the
GIT_SSL_CAPATHenvironment variable. - http.sslBackend
-
Name of the SSL backend to use (e.g. "openssl" or "schannel"). This option is ignored if cURL lacks support for choosing the SSL backend at runtime.
- http.sslCertType
-
Type of client certificate used when fetching or pushing over HTTPS. "PEM", "DER" are supported when using openssl or gnutls backends. "P12" is supported on "openssl", "schannel", "securetransport", and gnutls 8.11+. See also libcurl
CURLOPT_SSLCERTTYPE. Can be overridden by theGIT_SSL_CERT_TYPEenvironment variable. - http.sslKeyType
-
Type of client private key used when fetching or pushing over HTTPS. (e.g. "PEM", "DER", or "ENG"). Only applicable when using "openssl" backend. "DER" is not supported with openssl. Particularly useful when set to "ENG" for authenticating with PKCS#11 tokens, with a PKCS#11 URL in sslCert option. See also libcurl
CURLOPT_SSLKEYTYPE. Can be overridden by theGIT_SSL_KEY_TYPEenvironment variable. - http.schannelCheckRevoke
-
Used to enforce or disable certificate revocation checks in cURL when http.sslBackend is set to "schannel". Defaults to
trueif unset. Only necessary to disable this if Git consistently errors and the message is about checking the revocation status of a certificate. This option is ignored if cURL lacks support for setting the relevant SSL option at runtime. - http.schannelUseSSLCAInfo
-
As of cURL v7.60.0, the Secure Channel backend can use the certificate bundle provided via
http.sslCAInfo, but that would override the Windows Certificate Store. Since this is not desirable by default, Git will tell cURL not to use that bundle by default when theschannelbackend was configured viahttp.sslBackend, unlesshttp.schannelUseSSLCAInfooverrides this behavior. - http.pinnedPubkey
-
Public key of the https service. It may either be the filename of a PEM or DER encoded public key file or a string starting with sha256// followed by the base64 encoded sha256 hash of the public key. See also libcurl CURLOPT_PINNEDPUBLICKEY. git will exit with an error if this option is set but not supported by cURL.
- http.sslTry
-
Attempt to use AUTH SSL/TLS and encrypted data transfers when connecting via regular FTP protocol. This might be needed if the FTP server requires it for security reasons or you wish to connect securely whenever remote FTP server supports it. Default is false since it might trigger certificate verification errors on misconfigured servers.
- http.maxRequests
-
How many HTTP requests to launch in parallel. Can be overridden by the
GIT_HTTP_MAX_REQUESTSenvironment variable. Default is 5. - http.minSessions
-
The number of curl sessions (counted across slots) to be kept across requests. They will not be ended with curl_easy_cleanup() until http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this value will be capped at 1. Defaults to 1.
- http.postBuffer
-
Maximum size in bytes of the buffer used by smart HTTP transports when POSTing data to the remote system. For requests larger than this buffer size, HTTP/1.1 and Transfer-Encoding: chunked is used to avoid creating a massive pack file locally. Default is 1 MiB, which is sufficient for most requests.
Note that raising this limit is only effective for disabling chunked transfer encoding and therefore should be used only where the remote server or a proxy only supports HTTP/1.0 or is noncompliant with the HTTP standard. Raising this is not, in general, an effective solution for most push problems, but can increase memory consumption significantly since the entire buffer is allocated even for small pushes.
- http.lowSpeedLimit
- http.lowSpeedTime
-
If the HTTP transfer speed, in bytes per second, is less than http.lowSpeedLimit for longer than http.lowSpeedTime seconds, the transfer is aborted. Can be overridden by the
GIT_HTTP_LOW_SPEED_LIMITandGIT_HTTP_LOW_SPEED_TIMEenvironment variables. - http.keepAliveIdle
-
Specifies how long in seconds to wait on an idle connection before sending TCP keepalive probes (if supported by the OS). If unset, curl’s default value is used. Can be overridden by the
GIT_HTTP_KEEPALIVE_IDLEenvironment variable. - http.keepAliveInterval
-
Specifies how long in seconds to wait between TCP keepalive probes (if supported by the OS). If unset, curl’s default value is used. Can be overridden by the
GIT_HTTP_KEEPALIVE_INTERVALenvironment variable. - http.keepAliveCount
-
Specifies how many TCP keepalive probes to send before giving up and terminating the connection (if supported by the OS). If unset, curl’s default value is used. Can be overridden by the
GIT_HTTP_KEEPALIVE_COUNTenvironment variable. - http.noEPSV
-
A boolean which disables using of EPSV ftp command by curl. This can be helpful with some "poor" ftp servers which don’t support EPSV mode. Can be overridden by the
GIT_CURL_FTP_NO_EPSVenvironment variable. Default is false (curl will use EPSV). - http.userAgent
-
The HTTP USER_AGENT string presented to an HTTP server. The default value represents the version of the Git client such as git/1.7.1. This option allows you to override this value to a more common value such as Mozilla/4.0. This may be necessary, for instance, if connecting through a firewall that restricts HTTP connections to a set of common USER_AGENT strings (but not including those like git/1.7.1). Can be overridden by the
GIT_HTTP_USER_AGENTenvironment variable. - http.followRedirects
-
Whether git should follow HTTP redirects. If set to
true, git will transparently follow any redirect issued by a server it encounters. If set tofalse, git will treat all redirects as errors. If set toinitial, git will follow redirects only for the initial request to a remote, but not for subsequent follow-up HTTP requests. Since git uses the redirected URL as the base for the follow-up requests, this is generally sufficient. The default isinitial. - http.<url>.*
-
Any of the http.* options above can be applied selectively to some URLs. For a config key to match a URL, each element of the config key is compared to that of the URL, in the following order:
-
Scheme (e.g.,
httpsinhttps://example.com/). This field must match exactly between the config key and the URL. -
Host/domain name (e.g.,
example.cominhttps://example.com/). This field must match between the config key and the URL. It is possible to specify a*as part of the host name to match all subdomains at this level.https://*.example.com/for example would matchhttps://foo.example.com/, but nothttps://foo.bar.example.com/. -
Port number (e.g.,
8080inhttp://example.com:8080/). This field must match exactly between the config key and the URL. Omitted port numbers are automatically converted to the correct default for the scheme before matching. -
Path (e.g.,
repo.gitinhttps://example.com/repo.git). The path field of the config key must match the path field of the URL either exactly or as a prefix of slash-delimited path elements. This means a config key with pathfoo/matches URL pathfoo/bar. A prefix can only match on a slash (/) boundary. Longer matches take precedence (so a config key with pathfoo/baris a better match to URL pathfoo/barthan a config key with just pathfoo/). -
User name (e.g.,
userinhttps://user@example.com/repo.git). If the config key has a user name it must match the user name in the URL exactly. If the config key does not have a user name, that config key will match a URL with any user name (including none), but at a lower precedence than a config key with a user name.
The list above is ordered by decreasing precedence; a URL that matches a config key’s path is preferred to one that matches its user name. For example, if the URL is
https://user@example.com/foo/bara config key match ofhttps://example.com/foowill be preferred over a config key match ofhttps://user@example.com.All URLs are normalized before attempting any matching (the password part, if embedded in the URL, is always ignored for matching purposes) so that equivalent URLs that are simply spelled differently will match properly. Environment variable settings always override any matches. The URLs that are matched against are those given directly to Git commands. This means any URLs visited as a result of a redirection do not participate in matching.
-
- i18n.commitEncoding
-
Character encoding the commit messages are stored in; Git itself does not care per se, but this information is necessary e.g. when importing commits from emails or in the gitk graphical history browser (and possibly in other places in the future or in other porcelains). See e.g. git-mailinfo[1]. Defaults to utf-8.
- i18n.logOutputEncoding
-
Character encoding the commit messages are converted to when running git log and friends.
- imap.folder
-
The folder to drop the mails into, which is typically the Drafts folder. For example:
INBOX.Drafts,INBOX/Draftsor [Gmail]/Drafts. The IMAP folder to interact with MUST be specified; the value of this configuration variable is used as the fallback default value when the--folderoption is not given. - imap.tunnel
-
Command used to set up a tunnel to the IMAP server through which commands will be piped instead of using a direct network connection to the server. Required when imap.host is not set.
- imap.host
-
A URL identifying the server. Use an
imap://prefix for non-secure connections and animaps://prefix for secure connections. Ignored when imap.tunnel is set, but required otherwise. - imap.user
-
The username to use when logging in to the server.
- imap.pass
-
The password to use when logging in to the server.
- imap.port
-
An integer port number to connect to on the server. Defaults to 143 for imap:// hosts and 993 for imaps:// hosts. Ignored when imap.tunnel is set.
- imap.sslverify
-
A boolean to enable/disable verification of the server certificate used by the SSL/TLS connection. Default is
true. Ignored when imap.tunnel is set. - imap.preformattedHTML
-
A boolean to enable/disable the use of html encoding when sending a patch. An html encoded patch will be bracketed with <pre> and have a content type of text/html. Ironically, enabling this option causes Thunderbird to send the patch as a plain/text, format=fixed email. Default is
false. - imap.authMethod
-
Specify the authentication method for authenticating with the IMAP server. If Git was built with the NO_CURL option, or if your curl version is older than 7.34.0, or if you’re running git-imap-send with the
--no-curloption, the only supported methods arePLAIN,CRAM-MD5,OAUTHBEARERandXOAUTH2. If this is not set thengitimap-senduses the basic IMAP plaintextLOGINcommand. - include.path
- includeIf.<condition>.path
-
Special variables to include other configuration files. See the "CONFIGURATION FILE" section in the main git-config[1] documentation, specifically the "Includes" and "Conditional Includes" subsections.
- index.recordEndOfIndexEntries
-
Specifies whether the index file should include an "End Of Index Entry" section. This reduces index load time on multiprocessor machines but produces a message "ignoring EOIE extension" when reading the index using Git versions before 2.20. Defaults to true if index.threads has been explicitly enabled, false otherwise.
- index.recordOffsetTable
-
Specifies whether the index file should include an "Index Entry Offset Table" section. This reduces index load time on multiprocessor machines but produces a message "ignoring IEOT extension" when reading the index using Git versions before 2.20. Defaults to true if index.threads has been explicitly enabled, false otherwise.
- index.sparse
-
When enabled, write the index using sparse-directory entries. This has no effect unless
core.sparseCheckoutandcore.sparseCheckoutConeare both enabled. Defaults to false. - index.threads
-
Specifies the number of threads to spawn when loading the index. This is meant to reduce index load time on multiprocessor machines. Specifying 0 or true will cause Git to auto-detect the number of CPUs and set the number of threads accordingly. Specifying 1 or false will disable multithreading. Defaults to true.
- index.version
-
Specify the version with which new index files should be initialized. This does not affect existing repositories. If
feature.manyFilesis enabled, then the default is 4. - index.skipHash
-
When enabled, do not compute the trailing hash for the index file. This accelerates Git commands that manipulate the index, such as
gitadd,gitcommit, orgitstatus. Instead of storing the checksum, write a trailing set of bytes with value zero, indicating that the computation was skipped.If you enable
index.skipHash, then Git clients older than 2.13.0 will refuse to parse the index and Git clients older than 2.40.0 will report an error duringgitfsck.
init.templateDir-
Specify the directory from which templates will be copied. (See the "TEMPLATE DIRECTORY" section of git-init[1].)
init.defaultBranch-
Allows overriding the default branch name e.g. when initializing a new repository.
init.defaultObjectFormat-
Allows overriding the default object format for new repositories. See
--object-format=in git-init[1]. Both the command line option and theGIT_DEFAULT_HASHenvironment variable take precedence over this config. init.defaultRefFormat-
Allows overriding the default ref storage format for new repositories. See
--ref-format=in git-init[1]. Both the command line option and theGIT_DEFAULT_REF_FORMATenvironment variable take precedence over this config. - instaweb.browser
-
Specify the program that will be used to browse your working repository in gitweb. See git-instaweb[1].
- instaweb.httpd
-
The HTTP daemon command-line to start gitweb on your working repository. See git-instaweb[1].
- instaweb.local
-
If true the web server started by git-instaweb[1] will be bound to the local IP (127.0.0.1).
- instaweb.modulePath
-
The default module path for git-instaweb[1] to use instead of /usr/lib/apache2/modules. Only used if httpd is Apache.
- instaweb.port
-
The port number to bind the gitweb httpd to. See git-instaweb[1].
- interactive.singleKey
-
When set to true, allow the user to provide one-letter input with a single key (i.e., without hitting the Enter key) in interactive commands. This is currently used by the
--patchmode of git-add[1], git-checkout[1], git-restore[1], git-commit[1], git-reset[1], and git-stash[1]. - interactive.diffFilter
-
When an interactive command (such as
gitadd--patch) shows a colorized diff, git will pipe the diff through the shell command defined by this configuration variable. The command may mark up the diff further for human consumption, provided that it retains a one-to-one correspondence with the lines in the original diff. Defaults to disabled (no filtering). log.abbrevCommit-
If
true, make git-log[1], git-show[1], and git-whatchanged[1] assume--abbrev-commit. You may override this option with--no-abbrev-commit. log.date-
Set the default date-time mode for the
logcommand. Setting a value for log.date is similar to usinggitlog's--dateoption. See git-log[1] for details.If the format is set to "auto:foo" and the pager is in use, format "foo" will be used for the date format. Otherwise, "default" will be used.
log.decorate-
Print out the ref names of any commits that are shown by the log command. Possible values are:
This is the same as the
--decorateoption of thegitlog. log.initialDecorationSet-
By default,
gitlogonly shows decorations for certain known ref namespaces. If all is specified, then show all refs as decorations. log.excludeDecoration-
Exclude the specified patterns from the log decorations. This is similar to the
--decorate-refs-excludecommand-line option, but the config option can be overridden by the--decorate-refsoption. log.diffMerges-
Set diff format to be used when
--diff-merges=onis specified, see--diff-mergesin git-log[1] for details. Defaults toseparate. log.follow-
If
true,gitlogwill act as if the--followoption was used when a single <path> is given. This has the same limitations as--follow, i.e. it cannot be used to follow multiple files and does not work well on non-linear history. log.graphColors-
A list of colors, separated by commas, that can be used to draw history lines in
gitlog--graph. log.showRoot-
If true, the initial commit will be shown as a big creation event. This is equivalent to a diff against an empty tree. Tools like git-log[1] or git-whatchanged[1], which normally hide the root commit will now show it. True by default.
log.showSignature-
If true, makes git-log[1], git-show[1], and git-whatchanged[1] assume
--show-signature. log.mailmap-
If true, makes git-log[1], git-show[1], and git-whatchanged[1] assume
--use-mailmap, otherwise assume--no-use-mailmap. True by default. - lsrefs.unborn
-
May be "advertise" (the default), "allow", or "ignore". If "advertise", the server will respond to the client sending "unborn" (as described in gitprotocol-v2[5]) and will advertise support for this feature during the protocol v2 capability advertisement. "allow" is the same as "advertise" except that the server will not advertise support for this feature; this is useful for load-balanced servers that cannot be updated atomically (for example), since the administrator could configure "allow", then after a delay, configure "advertise".
- mailinfo.scissors
-
If true, makes git-mailinfo[1] (and therefore git-am[1]) act by default as if the --scissors option was provided on the command-line. When active, this feature removes everything from the message body before a scissors line (i.e. consisting mainly of ">8", "8<" and "-").
- mailmap.file
-
The location of an augmenting mailmap file. The default mailmap, located in the root of the repository, is loaded first, then the mailmap file pointed to by this variable. The location of the mailmap file may be in a repository subdirectory, or somewhere outside of the repository itself. See git-shortlog[1] and git-blame[1].
- mailmap.blob
-
Like
mailmap.file, but consider the value as a reference to a blob in the repository. If bothmailmap.fileandmailmap.blobare given, both are parsed, with entries frommailmap.filetaking precedence. In a bare repository, this defaults toHEAD:.mailmap. In a non-bare repository, it defaults to empty.