1git-remote(1) 2============ 3 4NAME 5---- 6git-remote - manage set of tracked repositories 7 8 9SYNOPSIS 10-------- 11[verse] 12'git remote' [-v | --verbose] 13'git remote add' [-t <branch>] [-m <master>] [-f] [--mirror] <name> <url> 14'git remote rename' <old> <new> 15'git remote rm' <name> 16'git remote set-head' <name> [-a | -d | <branch>] 17'git remote show' [-n] <name> 18'git remote prune' [-n | --dry-run] <name> 19'git remote update' [-p | --prune] [group | remote]... 20 21DESCRIPTION 22----------- 23 24Manage the set of repositories ("remotes") whose branches you track. 25 26 27OPTIONS 28------- 29 30-v:: 31--verbose:: 32 Be a little more verbose and show remote url after name. 33 34 35COMMANDS 36-------- 37 38With no arguments, shows a list of existing remotes. Several 39subcommands are available to perform operations on the remotes. 40 41'add':: 42 43Adds a remote named <name> for the repository at 44<url>. The command `git fetch <name>` can then be used to create and 45update remote-tracking branches <name>/<branch>. 46+ 47With `-f` option, `git fetch <name>` is run immediately after 48the remote information is set up. 49+ 50With `-t <branch>` option, instead of the default glob 51refspec for the remote to track all branches under 52`$GIT_DIR/remotes/<name>/`, a refspec to track only `<branch>` 53is created. You can give more than one `-t <branch>` to track 54multiple branches without grabbing all branches. 55+ 56With `-m <master>` option, `$GIT_DIR/remotes/<name>/HEAD` is set 57up to point at remote's `<master>` branch. See also the set-head command. 58+ 59In mirror mode, enabled with `\--mirror`, the refs will not be stored 60in the 'refs/remotes/' namespace, but in 'refs/heads/'. This option 61only makes sense in bare repositories. If a remote uses mirror 62mode, furthermore, `git push` will always behave as if `\--mirror` 63was passed. 64 65'rename':: 66 67Rename the remote named <old> to <new>. All remote tracking branches and 68configuration settings for the remote are updated. 69+ 70In case <old> and <new> are the same, and <old> is a file under 71`$GIT_DIR/remotes` or `$GIT_DIR/branches`, the remote is converted to 72the configuration file format. 73 74'rm':: 75 76Remove the remote named <name>. All remote tracking branches and 77configuration settings for the remote are removed. 78 79'set-head':: 80 81Sets or deletes the default branch (`$GIT_DIR/remotes/<name>/HEAD`) for 82the named remote. Having a default branch for a remote is not required, 83but allows the name of the remote to be specified in lieu of a specific 84branch. For example, if the default branch for `origin` is set to 85`master`, then `origin` may be specified wherever you would normally 86specify `origin/master`. 87+ 88With `-d`, `$GIT_DIR/remotes/<name>/HEAD` is deleted. 89+ 90With `-a`, the remote is queried to determine its `HEAD`, then 91`$GIT_DIR/remotes/<name>/HEAD` is set to the same branch. e.g., if the remote 92`HEAD` is pointed at `next`, "`git remote set-head origin -a`" will set 93`$GIT_DIR/refs/remotes/origin/HEAD` to `refs/remotes/origin/next`. This will 94only work if `refs/remotes/origin/next` already exists; if not it must be 95fetched first. 96+ 97Use `<branch>` to set `$GIT_DIR/remotes/<name>/HEAD` explicitly. e.g., "git 98remote set-head origin master" will set `$GIT_DIR/refs/remotes/origin/HEAD` to 99`refs/remotes/origin/master`. This will only work if 100`refs/remotes/origin/master` already exists; if not it must be fetched first. 101+ 102 103'show':: 104 105Gives some information about the remote <name>. 106+ 107With `-n` option, the remote heads are not queried first with 108`git ls-remote <name>`; cached information is used instead. 109 110'prune':: 111 112Deletes all stale tracking branches under <name>. 113These stale branches have already been removed from the remote repository 114referenced by <name>, but are still locally available in 115"remotes/<name>". 116+ 117With `--dry-run` option, report what branches will be pruned, but do not 118actually prune them. 119 120'update':: 121 122Fetch updates for a named set of remotes in the repository as defined by 123remotes.<group>. If a named group is not specified on the command line, 124the configuration parameter remotes.default will be used; if 125remotes.default is not defined, all remotes which do not have the 126configuration parameter remote.<name>.skipDefaultUpdate set to true will 127be updated. (See linkgit:git-config[1]). 128+ 129With `--prune` option, prune all the remotes that are updated. 130 131 132DISCUSSION 133---------- 134 135The remote configuration is achieved using the `remote.origin.url` and 136`remote.origin.fetch` configuration variables. (See 137linkgit:git-config[1]). 138 139Examples 140-------- 141 142* Add a new remote, fetch, and check out a branch from it 143+ 144------------ 145$ git remote 146origin 147$ git branch -r 148origin/master 149$ git remote add linux-nfs git://linux-nfs.org/pub/linux/nfs-2.6.git 150$ git remote 151linux-nfs 152origin 153$ git fetch 154* refs/remotes/linux-nfs/master: storing branch 'master' ... 155 commit: bf81b46 156$ git branch -r 157origin/master 158linux-nfs/master 159$ git checkout -b nfs linux-nfs/master 160... 161------------ 162 163* Imitate 'git-clone' but track only selected branches 164+ 165------------ 166$ mkdir project.git 167$ cd project.git 168$ git init 169$ git remote add -f -t master -m master origin git://example.com/git.git/ 170$ git merge origin 171------------ 172 173 174SEE ALSO 175-------- 176linkgit:git-fetch[1] 177linkgit:git-branch[1] 178linkgit:git-config[1] 179 180Author 181------ 182Written by Junio Hamano 183 184 185Documentation 186-------------- 187Documentation by J. Bruce Fields and the git-list <git@vger.kernel.org>. 188 189 190GIT 191--- 192Part of the linkgit:git[1] suite