Git - git-fetch Documentation
View originalCrawl details
- Current
Summary (TL;DR)
This document details the options and arguments for the git fetch command. Key options include --all to fetch from all remotes (except those with skipFetchAll set), --atomic for atomic ref updates, --depth to limit commit history, --prune to remove stale remote-tracking refs, --tags to fetch all tags, --recurse-submodules to control submodule fetching, and --negotiation-tip to restrict commit negotiation. Arguments include <repository> (URL or remote name), <group> for remote lists, and <refspec> defining which refs to fetch and update. Negative refspecs (^) can exclude refs. Force updates are allowed with + or --force, but refs/heads/* cannot accept non-commit objects. The document also explains default behavior for tag fetching, pruning rules, and the effect of --no-tags.
--all--no-all-
Fetch all remotes, except for the ones that have the
remote.<name>.skipFetchAllconfiguration variable set. This overrides the configuration variablefetch.all. -a--append-
Append ref names and object names of fetched refs to the existing contents of
.git/FETCH_HEAD. Without this option old data in.git/FETCH_HEADwill be overwritten. --atomic-
Use an atomic transaction to update local refs. Either all refs are updated, or on error, no refs are updated.
--depth=<depth>-
Limit fetching to the specified number of commits from the tip of each remote branch history. If fetching to a shallow repository created by
gitclonewith--depth=<depth> option (see git-clone[1]), deepen or shorten the history to the specified number of commits. Tags for the deepened commits are not fetched. --deepen=<depth>-
Similar to
--depth, except it specifies the number of commits from the current shallow boundary instead of from the tip of each remote branch history. --shallow-since=<date>-
Deepen or shorten the history of a shallow repository to include all reachable commits after <date>.
--shallow-exclude=<ref>-
Deepen or shorten the history of a shallow repository to exclude commits reachable from a specified remote branch or tag. This option can be specified multiple times.
--unshallow-
If the source repository is complete, convert a shallow repository to a complete one, removing all the limitations imposed by shallow repositories.
If the source repository is shallow, fetch as much as possible so that the current repository has the same history as the source repository.
--update-shallow-
By default when fetching from a shallow repository,
gitfetchrefuses refs that require updating.git/shallow. This option updates.git/shallowand accepts such refs. --negotiation-restrict=(<commit>|<glob>)--negotiation-tip=(<commit>|<glob>)-
By default, Git will report, to the server, commits reachable from all local refs to find common commits in an attempt to reduce the size of the to-be-received packfile. If specified, Git will only report commits reachable from the given tips. This is useful to speed up fetches when the user knows which local ref is likely to have commits in common with the upstream ref being fetched.
--negotiation-restrictis the preferred name for this option;--negotiation-tipis accepted as a synonym.This option may be specified more than once; if so, Git will report commits reachable from any of the given commits.
The argument to this option may be a glob on ref names, a ref, or the (possibly abbreviated) SHA-1 of a commit. Specifying a glob is equivalent to specifying this option multiple times, one for each matching ref name.
See also the
fetch.negotiationAlgorithmandpush.negotiateconfiguration variables documented in git-config[1], and the--negotiate-onlyoption below. --negotiation-include=(<commit>|<glob>)-
Ensure that the commits at the given tips are always sent as "have" lines during fetch negotiation, regardless of what the negotiation algorithm selects. This is useful to guarantee that common history reachable from specific refs is always considered, even when
--negotiation-restrictrestricts the set of tips or when the negotiation algorithm would otherwise skip them.This option may be specified more than once; if so, each commit is sent unconditionally.
The argument may be an exact ref name (e.g.
refs/heads/release), an object hash, or a glob pattern (e.g.refs/heads/release/{asterisk}). The pattern syntax is the same as for--negotiation-restrict.If
--negotiation-restrictis used, the have set is first restricted by that option and then increased to include the tips specified by--negotiation-include.If this option is not specified on the command line, then any
remote.<name>.negotiationIncludeconfig values for the current remote are used instead. --negotiate-only-
Do not fetch anything from the server, and instead print the ancestors of the provided
--negotiation-restrict=arguments, which we have in common with the server.This is incompatible with
--recurse-submodules=(yes|on-demand). Internally this is used to implement thepush.negotiateoption, see git-config[1]. --dry-run-
Show what would be done, without making any changes.
--porcelain-
Print the output to standard output in an easy-to-parse format for scripts. See section OUTPUT in git-fetch[1] for details.
This is incompatible with
--recurse-submodules=(yes|on-demand) and takes precedence over thefetch.outputconfig option. --filter=<filter-spec>-
Use the partial clone feature and request that the server sends a subset of reachable objects according to a given object filter. When using
--filter, the supplied <filter-spec> is used for the partial fetch.If
--filter=autois used, the filter specification is determined automatically by combining the filter specifications advertised by the server for the promisor remotes that the client accepts (see gitprotocol-v2[5] and thepromisor.acceptFromServerconfiguration option in git-config[1]).For details on all other available filter specifications, see the
--filter=<filter-spec> option in git-rev-list[1].For example,
--filter=blob:nonewill filter out all blobs (file contents) until needed by Git. Also,--filter=blob:limit=<size> will filter out all blobs of size at least <size>. --write-fetch-head--no-write-fetch-head-
Write the list of remote refs fetched in the
FETCH_HEADfile directly under$GIT_DIR. This is the default. Passing--no-write-fetch-headfrom the command line tells Git not to write the file. Under--dry-runoption, the file is never written. -f--force-
When
gitfetchis used with <src>:<dst> refspec, it may refuse to update the local branch as discussed in the <refspec> part below. This option overrides that check. -k--keep-
Keep downloaded pack.
--multiple-
Allow several <repository> and <group> arguments to be specified. No <refspec>s may be specified.
--auto-maintenance--no-auto-maintenance--auto-gc--no-auto-gc-
Run
gitmaintenancerun--autoat the end to perform automatic repository maintenance if needed. This is enabled by default. --write-commit-graph--no-write-commit-graph-
Write a commit-graph after fetching. This overrides the config setting
fetch.writeCommitGraph. --prefetch-
Modify the configured refspec to place all refs into the
refs/prefetch/namespace. See theprefetchtask in git-maintenance[1]. -p--prune-
Before fetching, remove any remote-tracking references that no longer exist on the remote. Tags are not subject to pruning if they are fetched only because of the default tag auto-following or due to a
--tagsoption. However, if tags are fetched due to an explicit refspec (either on the command line or in the remote configuration, for example if the remote was cloned with the--mirroroption), then they are also subject to pruning. Supplying--prune-tagsis a shorthand for providing the tag refspec.See the PRUNING section below for more details.
-P--prune-tags-
Before fetching, remove any local tags that no longer exist on the remote if
--pruneis enabled. This option should be used more carefully, unlike--pruneit will remove any local references (local tags) that have been created. This option is a shorthand for providing the explicit tag refspec along with--prune, see the discussion about that in its documentation.See the PRUNING section below for more details.
-n--no-tags-
By default, tags that point at objects that are downloaded from the remote repository are fetched and stored locally. This option disables this automatic tag following. The default behavior for a remote may be specified with the
remote.<name>.tagOptsetting. See git-config[1]. --refetch-
Instead of negotiating with the server to avoid transferring commits and associated objects that are already present locally, this option fetches all objects as a fresh clone would. Use this to reapply a partial clone filter from configuration or using
--filter=when the filter definition has changed. Automatic post-fetch maintenance will perform object database pack consolidation to remove any duplicate objects. --refmap=<refspec>-
When fetching refs listed on the command line, use the specified refspec (can be given more than once) to map the refs to remote-tracking branches, instead of the values of
remote.<name>.fetchconfiguration variables for the remote repository. Providing an empty <refspec> to the--refmapoption causes Git to ignore the configured refspecs and rely entirely on the refspecs supplied as command-line arguments. See section on "Configured Remote-tracking Branches" for details. -t--tags-
Fetch all tags from the remote (i.e., fetch remote tags
refs/tags/*into local tags with the same name), in addition to whatever else would otherwise be fetched. Using this option alone does not subject tags to pruning, even if--pruneis used (though tags may be pruned anyway if they are also the destination of an explicit refspec; see--prune). --recurse-submodules[=(yes|on-demand|no)]-
Control if and under what conditions new commits of submodules should be fetched too. When recursing through submodules,
gitfetchalways attempts to fetch "changed" submodules, that is, a submodule that has commits that are referenced by a newly fetched superproject commit but are missing in the local submodule clone. A changed submodule can be fetched as long as it is present locally e.g. in$GIT_DIR/modules/(see gitsubmodules[7]); if the upstream adds a new submodule, that submodule cannot be fetched until it is cloned e.g. bygitsubmoduleupdate.When set to
on-demand, only changed submodules are fetched. When set toyes, all populated submodules are fetched and submodules that are both unpopulated and changed are fetched. When set tono, submodules are never fetched.When unspecified, this uses the value of
fetch.recurseSubmodulesif it is set (see git-config[1]), defaulting toon-demandif unset. When this option is used without any value, it defaults toyes. -j<n>--jobs=<n>-
Parallelize all forms of fetching up to <n> jobs at a time.
A value of 0 will use some reasonable default.
If the
--multipleoption was specified, the different remotes will be fetched in parallel. If multiple submodules are fetched, they will be fetched in parallel. To control them independently, use the config settingsfetch.parallelandsubmodule.fetchJobs(see git-config[1]).Typically, parallel recursive and multi-remote fetches will be faster. By default fetches are performed sequentially, not in parallel.
--no-recurse-submodules-
Disable recursive fetching of submodules (this has the same effect as using the
--recurse-submodules=nooption). --set-upstream-
If the remote is fetched successfully, add upstream (tracking) reference, used by argument-less git-pull[1] and other commands. For more information, see
branch.<name>.mergeandbranch.<name>.remotein git-config[1]. --submodule-prefix=<path>-
Prepend <path> to paths printed in informative messages such as "Fetching submodule foo". This option is used internally when recursing over submodules.
--recurse-submodules-default=(yes|on-demand)-
This option is used internally to temporarily provide a non-negative default value for the
--recurse-submodulesoption. All other methods of configuring fetch’s submodule recursion (such as settings in gitmodules[5] and git-config[1]) override this option, as does specifying--[no-]recurse-submodulesdirectly. -u--update-head-ok-
By default
gitfetchrefuses to update the head which corresponds to the current branch. This flag disables the check. This is purely for the internal use forgitpullto communicate withgitfetch, and unless you are implementing your own Porcelain you are not supposed to use it. --upload-pack<upload-pack>-
When given, and the repository to fetch from is handled by
gitfetch-pack,--exec=<upload-pack> is passed to the command to specify non-default path for the command run on the other end. -q--quiet-
Pass
--quiettogit-fetch-packand silence any other internally used git commands. Progress is not reported to the standard error stream. -v--verbose-
Be verbose.
--progress-
Progress status is reported on the standard error stream by default when it is attached to a terminal, unless
-qis specified. This flag forces progress status even if the standard error stream is not directed to a terminal. -o<option>--server-option=<option>-
Transmit the given string to the server when communicating using protocol version 2. The given string must not contain a NUL or LF character. The server’s handling of server options, including unknown ones, is server-specific. When multiple
--server-option=<option> are given, they are all sent to the other side in the order listed on the command line. When no--server-option=<option> is given from the command line, the values of configuration variableremote.<name>.serverOptionare used instead. --show-forced-updates-
By default, git checks if a branch is force-updated during fetch. This can be disabled through
fetch.showForcedUpdates, but the--show-forced-updatesoption guarantees this check occurs. See git-config[1]. --no-show-forced-updates-
By default, git checks if a branch is force-updated during fetch. Pass
--no-show-forced-updatesor setfetch.showForcedUpdatesto false to skip this check for performance reasons. If used duringgit-pullthe--ff-onlyoption will still check for forced updates before attempting a fast-forward update. See git-config[1]. -4--ipv4-
Use IPv4 addresses only, ignoring IPv6 addresses.
-6--ipv6-
Use IPv6 addresses only, ignoring IPv4 addresses.
- <repository>
-
The "remote" repository that is the source of a fetch or pull operation. This parameter can be either a URL (see the section GIT URLS below) or the name of a remote (see the section REMOTES below).
- <group>
-
A name referring to a list of repositories as the value of
remotes.<group> in the configuration file. (See git-config[1]).
- <refspec>
-
Specifies which refs to fetch and which local refs to update. When no <refspec>s appear on the command line, the refs to fetch are read from
remote.<repository>.fetchvariables instead (see CONFIGURED REMOTE-TRACKING BRANCHES below).The format of a <refspec> parameter is an optional plus
+, followed by the source <src>, followed by a colon:, followed by the destination <dst>. The colon can be omitted when <dst> is empty. <src> is typically a ref, or a glob pattern with a single*that is used to match a set of refs, but it can also be a fully spelled hex object name.A <refspec> may contain a
*in its <src> to indicate a simple pattern match. Such a refspec functions like a glob that matches any ref with the pattern. A pattern <refspec> must have one and only one*in both the <src> and <dst>. It will map refs to the destination by replacing the*with the contents matched from the source.If a refspec is prefixed by
^, it will be interpreted as a negative refspec. Rather than specifying which refs to fetch or which local refs to update, such a refspec will instead specify refs to exclude. A ref will be considered to match if it matches at least one positive refspec, and does not match any negative refspec. Negative refspecs can be useful to restrict the scope of a pattern refspec so that it will not include specific refs. Negative refspecs can themselves be pattern refspecs. However, they may only contain a <src> and do not specify a <dst>. Fully spelled out hex object names are also not supported.tag<tag> means the same asrefs/tags/<tag>:refs/tags/<tag>; it requests fetching everything up to the given tag.The remote ref that matches <src> is fetched, and if <dst> is not an empty string, an attempt is made to update the local ref that matches it.
Whether that update is allowed without
--forcedepends on the ref namespace it’s being fetched to, the type of object being fetched, and whether the update is considered to be a fast-forward. Generally, the same rules apply for fetching as when pushing, see the <refspec>... section of git-push[1] for what those are. Exceptions to those rules particular togitfetchare noted below.Until Git version 2.20, and unlike when pushing with git-push[1], any updates to
refs/tags/*would be accepted without+in the refspec (or--force). When fetching, we promiscuously considered all tag updates from a remote to be forced fetches. Since Git version 2.20, fetching to updaterefs/tags/*works the same way as when pushing. I.e. any updates will be rejected without+in the refspec (or--force).Unlike when pushing with git-push[1], any updates outside of
refs/{tags,heads}/*will be accepted without+in the refspec (or--force), whether that’s swapping e.g. a tree object for a blob, or a commit for another commit that doesn’t have the previous commit as an ancestor etc.Unlike when pushing with git-push[1], there is no configuration which’ll amend these rules, and nothing like a
pre-fetchhook analogous to thepre-receivehook.As with pushing with git-push[1], all of the rules described above about what’s not allowed as an update can be overridden by adding an optional leading
+to a refspec (or using the--forcecommand line option). The only exception to this is that no amount of forcing will make therefs/heads/*namespace accept a non-commit object.Note
When the remote branch you want to fetch is known to be rewound and rebased regularly, it is expected that its new tip will not be a descendant of its previous tip (as stored in your remote-tracking branch the last time you fetched). You would want to use the +sign to indicate non-fast-forward updates will be needed for such branches. There is no way to determine or declare that a branch will be made available in a repository with this behavior; the pulling user simply must know this is the expected usage pattern for a branch. --stdin-
Read refspecs, one per line, from stdin in addition to those provided as arguments. The "tag <name>" format is not supported.