]>
Commit | Line | Data |
---|---|---|
041e69c9 BF |
1 | git-remote(1) |
2 | ============ | |
3 | ||
4 | NAME | |
5 | ---- | |
a2f69581 | 6 | git-remote - Manage set of tracked repositories |
041e69c9 BF |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
11 | [verse] | |
b1889c36 | 12 | 'git remote' [-v | --verbose] |
0460ed2c | 13 | 'git remote add' [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=<fetch|push>] <name> <url> |
bf98421a | 14 | 'git remote rename' <old> <new> |
e17dba8f | 15 | 'git remote remove' <name> |
159543e8 | 16 | 'git remote set-head' <name> (-a | --auto | -d | --delete | <branch>) |
ca5bc9e6 | 17 | 'git remote set-branches' [--add] <name> <branch>... |
433f2be1 IL |
18 | 'git remote set-url' [--push] <name> <newurl> [<oldurl>] |
19 | 'git remote set-url --add' [--push] <name> <newurl> | |
20 | 'git remote set-url --delete' [--push] <name> <url> | |
b17dd3f9 TR |
21 | 'git remote' [-v | --verbose] 'show' [-n] <name>... |
22 | 'git remote prune' [-n | --dry-run] <name>... | |
0adda936 | 23 | 'git remote' [-v | --verbose] 'update' [-p | --prune] [(<group> | <remote>)...] |
041e69c9 BF |
24 | |
25 | DESCRIPTION | |
26 | ----------- | |
27 | ||
28 | Manage the set of repositories ("remotes") whose branches you track. | |
29 | ||
041e69c9 | 30 | |
459cf2e9 SB |
31 | OPTIONS |
32 | ------- | |
33 | ||
34 | -v:: | |
35 | --verbose:: | |
36 | Be a little more verbose and show remote url after name. | |
4504107d | 37 | NOTE: This must be placed between `remote` and `subcommand`. |
459cf2e9 SB |
38 | |
39 | ||
0f390875 SP |
40 | COMMANDS |
41 | -------- | |
42 | ||
43 | With no arguments, shows a list of existing remotes. Several | |
44 | subcommands are available to perform operations on the remotes. | |
45 | ||
46 | 'add':: | |
47 | ||
48 | Adds a remote named <name> for the repository at | |
041e69c9 BF |
49 | <url>. The command `git fetch <name>` can then be used to create and |
50 | update remote-tracking branches <name>/<branch>. | |
c5ddca1f JH |
51 | + |
52 | With `-f` option, `git fetch <name>` is run immediately after | |
53 | the remote information is set up. | |
54 | + | |
111fb858 ST |
55 | With `--tags` option, `git fetch <name>` imports every tag from the |
56 | remote repository. | |
57 | + | |
58 | With `--no-tags` option, `git fetch <name>` does not import tags from | |
59 | the remote repository. | |
60 | + | |
c5ddca1f JH |
61 | With `-t <branch>` option, instead of the default glob |
62 | refspec for the remote to track all branches under | |
0aceb220 | 63 | the `refs/remotes/<name>/` namespace, a refspec to track only `<branch>` |
c5ddca1f | 64 | is created. You can give more than one `-t <branch>` to track |
cf593cc4 | 65 | multiple branches without grabbing all branches. |
c5ddca1f | 66 | + |
0aceb220 | 67 | With `-m <master>` option, a symbolic-ref `refs/remotes/<name>/HEAD` is set |
bc14fac8 | 68 | up to point at remote's `<master>` branch. See also the set-head command. |
38944390 | 69 | + |
6cf378f0 | 70 | When a fetch mirror is created with `--mirror=fetch`, the refs will not |
a9f5a355 JK |
71 | be stored in the 'refs/remotes/' namespace, but rather everything in |
72 | 'refs/' on the remote will be directly mirrored into 'refs/' in the | |
73 | local repository. This option only makes sense in bare repositories, | |
74 | because a fetch would overwrite any local commits. | |
75 | + | |
6cf378f0 JK |
76 | When a push mirror is created with `--mirror=push`, then `git push` |
77 | will always behave as if `--mirror` was passed. | |
041e69c9 | 78 | |
bf98421a MV |
79 | 'rename':: |
80 | ||
0e615b25 | 81 | Rename the remote named <old> to <new>. All remote-tracking branches and |
bf98421a | 82 | configuration settings for the remote are updated. |
74443f18 MV |
83 | + |
84 | In case <old> and <new> are the same, and <old> is a file under | |
85 | `$GIT_DIR/remotes` or `$GIT_DIR/branches`, the remote is converted to | |
86 | the configuration file format. | |
bf98421a | 87 | |
e17dba8f | 88 | 'remove':: |
1b4cbb5d JB |
89 | 'rm':: |
90 | ||
0e615b25 | 91 | Remove the remote named <name>. All remote-tracking branches and |
1b4cbb5d JB |
92 | configuration settings for the remote are removed. |
93 | ||
bc14fac8 JS |
94 | 'set-head':: |
95 | ||
0aceb220 JH |
96 | Sets or deletes the default branch (i.e. the target of the |
97 | symbolic-ref `refs/remotes/<name>/HEAD`) for | |
bc14fac8 JS |
98 | the named remote. Having a default branch for a remote is not required, |
99 | but allows the name of the remote to be specified in lieu of a specific | |
100 | branch. For example, if the default branch for `origin` is set to | |
101 | `master`, then `origin` may be specified wherever you would normally | |
102 | specify `origin/master`. | |
103 | + | |
159543e8 | 104 | With `-d` or `--delete`, the symbolic ref `refs/remotes/<name>/HEAD` is deleted. |
bc14fac8 | 105 | + |
159543e8 | 106 | With `-a` or `--auto`, the remote is queried to determine its `HEAD`, then the |
0aceb220 | 107 | symbolic-ref `refs/remotes/<name>/HEAD` is set to the same branch. e.g., if the remote |
bc14fac8 | 108 | `HEAD` is pointed at `next`, "`git remote set-head origin -a`" will set |
0aceb220 | 109 | the symbolic-ref `refs/remotes/origin/HEAD` to `refs/remotes/origin/next`. This will |
bc14fac8 JS |
110 | only work if `refs/remotes/origin/next` already exists; if not it must be |
111 | fetched first. | |
112 | + | |
0aceb220 JH |
113 | Use `<branch>` to set the symbolic-ref `refs/remotes/<name>/HEAD` explicitly. e.g., "git |
114 | remote set-head origin master" will set the symbolic-ref `refs/remotes/origin/HEAD` to | |
bc14fac8 JS |
115 | `refs/remotes/origin/master`. This will only work if |
116 | `refs/remotes/origin/master` already exists; if not it must be fetched first. | |
117 | + | |
118 | ||
3d8b6949 JN |
119 | 'set-branches':: |
120 | ||
121 | Changes the list of branches tracked by the named remote. | |
122 | This can be used to track a subset of the available remote branches | |
123 | after the initial setup for a remote. | |
124 | + | |
125 | The named branches will be interpreted as if specified with the | |
126 | `-t` option on the 'git remote add' command line. | |
127 | + | |
128 | With `--add`, instead of replacing the list of currently tracked | |
129 | branches, adds to that list. | |
130 | ||
433f2be1 IL |
131 | 'set-url':: |
132 | ||
133 | Changes URL remote points to. Sets first URL remote points to matching | |
134 | regex <oldurl> (first URL if no <oldurl> is given) to <newurl>. If | |
135 | <oldurl> doesn't match any URL, error occurs and nothing is changed. | |
136 | + | |
137 | With '--push', push URLs are manipulated instead of fetch URLs. | |
138 | + | |
139 | With '--add', instead of changing some URL, new URL is added. | |
140 | + | |
141 | With '--delete', instead of changing some URL, all URLs matching | |
142 | regex <url> are deleted. Trying to delete all non-push URLs is an | |
143 | error. | |
144 | ||
0f390875 | 145 | 'show':: |
041e69c9 | 146 | |
0f390875 | 147 | Gives some information about the remote <name>. |
181ea688 SV |
148 | + |
149 | With `-n` option, the remote heads are not queried first with | |
150 | `git ls-remote <name>`; cached information is used instead. | |
0f390875 SP |
151 | |
152 | 'prune':: | |
153 | ||
8b3f3f84 | 154 | Deletes all stale remote-tracking branches under <name>. |
859607df | 155 | These stale branches have already been removed from the remote repository |
1e592d65 TT |
156 | referenced by <name>, but are still locally available in |
157 | "remotes/<name>". | |
181ea688 | 158 | + |
75f492ac | 159 | With `--dry-run` option, report what branches will be pruned, but do not |
8d767927 | 160 | actually prune them. |
1e592d65 TT |
161 | |
162 | 'update':: | |
163 | ||
1918278e TT |
164 | Fetch updates for a named set of remotes in the repository as defined by |
165 | remotes.<group>. If a named group is not specified on the command line, | |
75f492ac | 166 | the configuration parameter remotes.default will be used; if |
cb5c49b9 | 167 | remotes.default is not defined, all remotes which do not have the |
1918278e | 168 | configuration parameter remote.<name>.skipDefaultUpdate set to true will |
5162e697 | 169 | be updated. (See linkgit:git-config[1]). |
efa54803 FAG |
170 | + |
171 | With `--prune` option, prune all the remotes that are updated. | |
859607df | 172 | |
0f390875 SP |
173 | |
174 | DISCUSSION | |
175 | ---------- | |
176 | ||
041e69c9 BF |
177 | The remote configuration is achieved using the `remote.origin.url` and |
178 | `remote.origin.fetch` configuration variables. (See | |
5162e697 | 179 | linkgit:git-config[1]). |
041e69c9 BF |
180 | |
181 | Examples | |
182 | -------- | |
183 | ||
db554bf0 JH |
184 | * Add a new remote, fetch, and check out a branch from it |
185 | + | |
041e69c9 BF |
186 | ------------ |
187 | $ git remote | |
188 | origin | |
189 | $ git branch -r | |
34a25d4c TK |
190 | origin/HEAD -> origin/master |
191 | origin/master | |
192 | $ git remote add staging git://git.kernel.org/.../gregkh/staging.git | |
041e69c9 | 193 | $ git remote |
041e69c9 | 194 | origin |
34a25d4c TK |
195 | staging |
196 | $ git fetch staging | |
197 | ... | |
198 | From git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/staging | |
199 | * [new branch] master -> staging/master | |
200 | * [new branch] staging-linus -> staging/staging-linus | |
201 | * [new branch] staging-next -> staging/staging-next | |
041e69c9 | 202 | $ git branch -r |
34a25d4c TK |
203 | origin/HEAD -> origin/master |
204 | origin/master | |
205 | staging/master | |
206 | staging/staging-linus | |
207 | staging/staging-next | |
208 | $ git checkout -b staging staging/master | |
041e69c9 BF |
209 | ... |
210 | ------------ | |
211 | ||
0b444cdb | 212 | * Imitate 'git clone' but track only selected branches |
db554bf0 JH |
213 | + |
214 | ------------ | |
215 | $ mkdir project.git | |
216 | $ cd project.git | |
217 | $ git init | |
218 | $ git remote add -f -t master -m master origin git://example.com/git.git/ | |
219 | $ git merge origin | |
220 | ------------ | |
221 | ||
222 | ||
56ae8df5 | 223 | SEE ALSO |
041e69c9 | 224 | -------- |
5162e697 DM |
225 | linkgit:git-fetch[1] |
226 | linkgit:git-branch[1] | |
227 | linkgit:git-config[1] | |
041e69c9 | 228 | |
041e69c9 BF |
229 | GIT |
230 | --- | |
9e1f0a85 | 231 | Part of the linkgit:git[1] suite |