git-remote(1)

NAME#

git-remote - Manage set of tracked repositories

SYNOPSIS#

git remote\n [-v | --verbose]
\ngit remote add\n [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=(fetch|push)] <name> <URL>
\ngit remote rename\n [--[no-]progress] <old> <new>
\ngit remote remove\n <name>
\ngit remote set-head\n <name> (-a | --auto | -d | --delete | <branch>)
\ngit remote set-branches\n [--add] <name> <branch>...
\ngit remote get-url\n [--push] [--all] <name>
\ngit remote set-url\n [--push] <name> <newurl> [<oldurl>]
\ngit remote set-url --add\n [--push] <name> <newurl>
\ngit remote set-url --delete\n [--push] <name> <URL>
\ngit remote\n [-v | --verbose] \nshow\n [-n] <name>...
\ngit remote prune\n [-n | --dry-run] <name>...
\ngit remote\n [-v | --verbose] \nupdate\n [-p | --prune] [(<group> | <remote>)...]

DESCRIPTION#

Manage the set of repositories ("remotes") whose branches you track.

OPTIONS#

-v, --verbose

COMMANDS#

With no arguments, shows a list of existing remotes. Several subcommands are available to perform operations on the remotes.

add

With -f option, git fetch <name> is run immediately after the remote information is set up.

With --tags option, git fetch <name> imports every tag from the remote repository.

With --no-tags option, git fetch <name> does not import tags from the remote repository.

By default, only tags on fetched branches are imported (see git-fetch(1)).

With -t <branch> option, instead of the default glob refspec for the remote to track all branches under the refs/remotes/<name>/ namespace, a refspec to track only <branch> is created. You can give more than one -t <branch> to track multiple branches without grabbing all branches.

With -m <master> option, a symbolic-ref refs/remotes/<name>/HEAD is set up to point at remote’s <master> branch. See also the set-head command.

When a fetch mirror is created with --mirror=fetch, the refs will not be stored in the refs/remotes/ namespace, but rather everything in refs/ on the remote will be directly mirrored into refs/ in the local 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, then git push will always behave as if --mirror was passed.

rename

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 to the configuration file format.

remove, rm

set-head

With -d or --delete, the symbolic ref refs/remotes/<name>/HEAD is deleted.

With -a or --auto, the remote is queried to determine its HEAD, then the symbolic-ref refs/remotes/<name>/HEAD is set to the same branch. e.g., if the remote HEAD is pointed at next, git remote set-head origin -a will set the symbolic-ref refs/remotes/origin/HEAD to refs/remotes/origin/next. This will only work if refs/remotes/origin/next already exists; if not it must be fetched first.

Use <branch> to set the symbolic-ref refs/remotes/<name>/HEAD explicitly. e.g., git remote set-head origin master will set the symbolic-ref refs/remotes/origin/HEAD to refs/remotes/origin/master. This will only work if refs/remotes/origin/master already exists; if not it must be fetched first.

set-branches

The named branches will be interpreted as if specified with the -t option on the git remote add command line.

With --add, instead of replacing the list of currently tracked branches, adds to that list.

get-url

With --push, push URLs are queried rather than fetch URLs.

With --all, all URLs for the remote will be listed.

set-url

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 matching regex <URL> are deleted for remote <name>. Trying to delete all non-push URLs is an error.

Note that the push URL and the fetch URL, even though they can be set differently, must still refer to the same place. What you pushed to the push URL should be what you would see if you immediately fetched from the fetch URL. If you are trying to fetch from one place (e.g. your upstream) and push to another (e.g. your publishing repository), use two separate remotes.

show

With -n option, the remote heads are not queried first with git ls-remote <name>; cached information is used instead.

prune

See the PRUNING section of git-fetch(1) for what it’ll prune depending on various configuration.

With --dry-run option, report what branches would be pruned, but do not actually prune them.

update

With --prune option, run pruning against all the remotes that are updated.

DISCUSSION#

The remote configuration is achieved using the remote.origin.url and remote.origin.fetch configuration variables. (See git-config(1)).

EXIT STATUS#

On success, the exit status is 0.

When subcommands such as add, rename, and remove can’t find the remote in question, the exit status is 2. When the remote already exists, the exit status is 3.

On any other error, the exit status may be any other non-zero value.

EXAMPLES#

$ git remote
origin
$ git branch -r
\n
  origin/HEAD -> origin/master
\n
  origin/master
$ git remote add staging git://git.kernel.org/.../gregkh/staging.git
$ git remote
origin
staging
$ git fetch staging
...
From git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/staging
\n
 * [new branch]      master     -> staging/master
\n
 * [new branch]      staging-linus -> staging/staging-linus
\n
 * [new branch]      staging-next -> staging/staging-next
$ git branch -r
\n
  origin/HEAD -> origin/master
\n
  origin/master
\n
  staging/master
\n
  staging/staging-linus
\n
  staging/staging-next
$ git switch -c staging staging/master
...

$ mkdir project.git
$ cd project.git
$ git init
$ git remote add -f -t master -m master origin git://example.com/git.git/
$ git merge origin

SEE ALSO#

git-fetch(1) git-branch(1) git-config(1)

GIT#

Part of the git(1) suite