With no arguments, shows a list of existing remotes. Severalsubcommands are available to perform operations on the remotes.
- add
Add a remote named <name> for the repository at<URL>. The command
git fetch <name>
can then be used to create andupdate remote-tracking branches <name>/<branch>.With
-f
option,git fetch <name>
is run immediately afterthe remote information is set up.With
--tags
option,git fetch <name>
imports every tag from theremote repository.With
--no-tags
option,git fetch <name>
does not import tags fromthe remote repository.By default, only tags on fetched branches are imported(see git-fetch[1]).
With
-t <branch>
option, instead of the default globrefspec for the remote to track all branches undertherefs/remotes/<name>/
namespace, a refspec to track only<branch>
is created. You can give more than one-t <branch>
to trackmultiple branches without grabbing all branches.With
-m <master>
option, a symbolic-refrefs/remotes/<name>/HEAD
is setup to point at remote’s<master>
branch. See also the set-head command.See AlsoGit Fetch | Atlassian Git TutorialGit Fetch Command {How to Use It + Examples}Git - git-fetch DocumentationWhen a fetch mirror is created with
--mirror=fetch
, the refs will notbe stored in the refs/remotes/ namespace, but rather everything inrefs/ on the remote will be directly mirrored into refs/ in thelocal repository. This option only makes sense in bare repositories,because a fetch would overwrite any local commits.When a push mirror is created with
--mirror=push
, thengit push
will always behave as if--mirror
was passed.- rename
Rename the remote named <old> to <new>. All remote-tracking branches andconfiguration settings for the remote are updated.
In case <old> and <new> are the same, and <old> is a file under
$GIT_DIR/remotes
or$GIT_DIR/branches
, the remote is converted tothe configuration file format.- remove
- rm
Remove the remote named <name>. All remote-tracking branches andconfiguration settings for the remote are removed.
- set-head
Sets or deletes the default branch (i.e. the target of thesymbolic-ref
refs/remotes/<name>/HEAD
) forthe named remote. Having a default branch for a remote is not required,but allows the name of the remote to be specified in lieu of a specificbranch. For example, if the default branch fororigin
is set tomaster
, thenorigin
may be specified wherever you would normallyspecifyorigin/master
.With
-d
or--delete
, the symbolic refrefs/remotes/<name>/HEAD
is deleted.With
-a
or--auto
, the remote is queried to determine itsHEAD
, then thesymbolic-refrefs/remotes/<name>/HEAD
is set to the same branch. e.g., if the remoteHEAD
is pointed atnext
,git remote set-head origin -a
will setthe symbolic-refrefs/remotes/origin/HEAD
torefs/remotes/origin/next
. This willonly work ifrefs/remotes/origin/next
already exists; if not it must befetched first.Use
<branch>
to set the symbolic-refrefs/remotes/<name>/HEAD
explicitly. e.g.,gitremote set-head origin master
will set the symbolic-refrefs/remotes/origin/HEAD
torefs/remotes/origin/master
. This will only work ifrefs/remotes/origin/master
already exists; if not it must be fetched first.- set-branches
Changes the list of branches tracked by the named remote.This can be used to track a subset of the available remote branchesafter the initial setup for a remote.
The named branches will be interpreted as if specified with the
-t
option on thegit remote add
command line.With
--add
, instead of replacing the list of currently trackedbranches, adds to that list.- get-url
Retrieves the URLs for a remote. Configurations for
insteadOf
andpushInsteadOf
are expanded here. By default, only the first URL is listed.With
--push
, push URLs are queried rather than fetch URLs.With
--all
, all URLs for the remote will be listed.- set-url
Changes URLs for the remote. Sets first URL for remote <name> that matchesregex <oldurl> (first URL if no <oldurl> is given) to <newurl>. If<oldurl> doesn’t match any URL, an error occurs and nothing is changed.
With
--push
, push URLs are manipulated instead of fetch URLs.With
--add
, instead of changing existing URLs, new URL is added.With
--delete
, instead of changing existing URLs, all URLs matchingregex <URL> are deleted for remote <name>. Trying to delete allnon-push URLs is an error.Note that the push URL and the fetch URL, even though they canbe set differently, must still refer to the same place. What youpushed to the push URL should be what you would see if youimmediately fetched from the fetch URL. If you are trying tofetch from one place (e.g. your upstream) and push to another (e.g.your publishing repository), use two separate remotes.
- show
Gives some information about the remote <name>.
With
-n
option, the remote heads are not queried first withgit ls-remote <name>
; cached information is used instead.- prune
Deletes stale references associated with <name>. By default, staleremote-tracking branches under <name> are deleted, but depending onglobal configuration and the configuration of the remote we might evenprune local tags that haven’t been pushed there. Equivalent to
gitfetch --prune <name>
, except that no new references will be fetched.See the PRUNING section of git-fetch[1] for what it’ll prunedepending on various configuration.
With
--dry-run
option, report what branches would be pruned, but do notactually prune them.- update
Fetch updates for remotes or remote groups in the repository as defined by
remotes.<group>
. If neither group nor remote is specified on the command line,the configuration parameter remotes.default will be used; ifremotes.default is not defined, all remotes which do not have theconfiguration parameterremote.<name>.skipDefaultUpdate
set to true willbe updated. (See git-config[1]).With
--prune
option, run pruning against all the remotes that are updated.