6 git-push - Update remote refs along with associated objects
12 'git push' [--all | --mirror | --tags] [-n | --dry-run] [--receive-pack=<git-receive-pack>]
13 [--repo=<repository>] [-f | --force] [--prune] [-v | --verbose] [-u | --set-upstream]
14 [<repository> [<refspec>...]]
19 Updates remote refs using local refs, while sending objects
20 necessary to complete the given refs.
22 You can make interesting things happen to a repository
23 every time you push into it, by setting up 'hooks' there. See
24 documentation for linkgit:git-receive-pack[1].
30 The "remote" repository that is destination of a push
31 operation. This parameter can be either a URL
32 (see the section <<URLS,GIT URLS>> below) or the name
33 of a remote (see the section <<REMOTES,REMOTES>> below).
36 The format of a <refspec> parameter is an optional plus
37 `+`, followed by the source ref <src>, followed
38 by a colon `:`, followed by the destination ref <dst>.
39 It is used to specify what <src> object the <dst> ref
40 in the remote repository is to be updated to. If no
41 <refspec> is specified on the command line, and if no
42 <refspec> is configured for the <repository>,
43 the behavior of the command is controlled by the `push.default`
44 configuration variable, and if it is unset, the `simple`
45 behaviour is used (see lingit:git-config[1] and look
48 The <src> is often the name of the branch you would want to push, but
49 it can be any arbitrary "SHA-1 expression", such as `master~4` or
50 `HEAD` (see linkgit:gitrevisions[7]).
52 The <dst> tells which ref on the remote side is updated with this
53 push. Arbitrary expressions cannot be used here, an actual ref must
54 be named. If `:`<dst> is omitted, the same ref as <src> will be
57 The object referenced by <src> is used to update the <dst> reference
58 on the remote side. By default this is only allowed if <dst> is not
59 a tag (annotated or lightweight), and then only if it can fast-forward
60 <dst>. By having the optional leading `+`, you can tell Git to update
61 the <dst> ref even if it is not allowed by default (e.g., it is not a
62 fast-forward.) This does *not* attempt to merge <src> into <dst>. See
63 EXAMPLES below for details.
65 `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
67 Pushing an empty <src> allows you to delete the <dst> ref from
68 the remote repository.
70 The special refspec `:` (or `+:` to allow non-fast-forward updates)
71 directs Git to push "matching" branches: for every branch that exists on
72 the local side, the remote side is updated if a branch of the same name
73 already exists on the remote side.
76 Push all branches (i.e. refs under `refs/heads/`); cannot be
77 used with other <refspec>.
80 Remove remote branches that don't have a local counterpart. For example
81 a remote branch `tmp` will be removed if a local branch with the same
82 name doesn't exist any more. This also respects refspecs, e.g.
83 `git push --prune remote refs/heads/*:refs/tmp/*` would
84 make sure that remote `refs/tmp/foo` will be removed if `refs/heads/foo`
88 Instead of naming each ref to push, specifies that all
89 refs under `refs/` (which includes but is not
90 limited to `refs/heads/`, `refs/remotes/`, and `refs/tags/`)
91 be mirrored to the remote repository. Newly created local
92 refs will be pushed to the remote end, locally updated refs
93 will be force updated on the remote end, and deleted refs
94 will be removed from the remote end. This is the default
95 if the configuration option `remote.<remote>.mirror` is
100 Do everything except actually send the updates.
103 Produce machine-readable output. The output status line for each ref
104 will be tab-separated and sent to stdout instead of stderr. The full
105 symbolic names of the refs will be given.
108 All listed refs are deleted from the remote repository. This is
109 the same as prefixing all refs with a colon.
112 All refs under `refs/tags` are pushed, in
113 addition to refspecs explicitly listed on the command
116 --receive-pack=<git-receive-pack>::
117 --exec=<git-receive-pack>::
118 Path to the 'git-receive-pack' program on the remote
119 end. Sometimes useful when pushing to a remote
120 repository over ssh, and you do not have the program in
121 a directory on the default $PATH.
125 Usually, the command refuses to update a remote ref that is
126 not an ancestor of the local ref used to overwrite it.
127 This flag disables the check. This can cause the
128 remote repository to lose commits; use it with care.
130 --repo=<repository>::
131 This option is only relevant if no <repository> argument is
132 passed in the invocation. In this case, 'git push' derives the
133 remote name from the current branch: If it tracks a remote
134 branch, then that remote repository is pushed to. Otherwise,
135 the name "origin" is used. For this latter case, this option
136 can be used to override the name "origin". In other words,
137 the difference between these two commands
139 --------------------------
141 git push --repo=public #2
142 --------------------------
144 is that #1 always pushes to "public" whereas #2 pushes to "public"
145 only if the current branch does not track a remote branch. This is
146 useful if you write an alias or script around 'git push'.
150 For every branch that is up to date or successfully pushed, add
151 upstream (tracking) reference, used by argument-less
152 linkgit:git-pull[1] and other commands. For more information,
153 see 'branch.<name>.merge' in linkgit:git-config[1].
157 These options are passed to linkgit:git-send-pack[1]. A thin transfer
158 significantly reduces the amount of sent data when the sender and
159 receiver share many of the same objects in common. The default is
164 Suppress all output, including the listing of updated refs,
165 unless an error occurs. Progress is not reported to the standard
173 Progress status is reported on the standard error stream
174 by default when it is attached to a terminal, unless -q
175 is specified. This flag forces progress status even if the
176 standard error stream is not directed to a terminal.
178 --recurse-submodules=check|on-demand::
179 Make sure all submodule commits used by the revisions to be
180 pushed are available on a remote-tracking branch. If 'check' is
181 used Git will verify that all submodule commits that changed in
182 the revisions to be pushed are available on at least one remote
183 of the submodule. If any commits are missing the push will be
184 aborted and exit with non-zero status. If 'on-demand' is used
185 all submodules that changed in the revisions to be pushed will
186 be pushed. If on-demand was not able to push all necessary
187 revisions it will also be aborted and exit with non-zero status.
190 include::urls-remotes.txt[]
195 The output of "git push" depends on the transport method used; this
196 section describes the output when pushing over the Git protocol (either
199 The status of the push is output in tabular form, with each line
200 representing the status of a single ref. Each line is of the form:
202 -------------------------------
203 <flag> <summary> <from> -> <to> (<reason>)
204 -------------------------------
206 If --porcelain is used, then each line of the output is of the form:
208 -------------------------------
209 <flag> \t <from>:<to> \t <summary> (<reason>)
210 -------------------------------
212 The status of up-to-date refs is shown only if --porcelain or --verbose
216 A single character indicating the status of the ref:
217 (space);; for a successfully pushed fast-forward;
218 `+`;; for a successful forced update;
219 `-`;; for a successfully deleted ref;
220 `*`;; for a successfully pushed new ref;
221 `!`;; for a ref that was rejected or failed to push; and
222 `=`;; for a ref that was up to date and did not need pushing.
225 For a successfully pushed ref, the summary shows the old and new
226 values of the ref in a form suitable for using as an argument to
227 `git log` (this is `<old>..<new>` in most cases, and
228 `<old>...<new>` for forced non-fast-forward updates).
230 For a failed update, more details are given:
234 Git did not try to send the ref at all, typically because it
235 is not a fast-forward and you did not force the update.
238 The remote end refused the update. Usually caused by a hook
239 on the remote side, or because the remote repository has one
240 of the following safety options in effect:
241 `receive.denyCurrentBranch` (for pushes to the checked out
242 branch), `receive.denyNonFastForwards` (for forced
243 non-fast-forward updates), `receive.denyDeletes` or
244 `receive.denyDeleteCurrent`. See linkgit:git-config[1].
247 The remote end did not report the successful update of the ref,
248 perhaps because of a temporary error on the remote side, a
249 break in the network connection, or other transient error.
253 The name of the local ref being pushed, minus its
254 `refs/<type>/` prefix. In the case of deletion, the
255 name of the local ref is omitted.
258 The name of the remote ref being updated, minus its
259 `refs/<type>/` prefix.
262 A human-readable explanation. In the case of successfully pushed
263 refs, no explanation is needed. For a failed ref, the reason for
264 failure is described.
266 Note about fast-forwards
267 ------------------------
269 When an update changes a branch (or more in general, a ref) that used to
270 point at commit A to point at another commit B, it is called a
271 fast-forward update if and only if B is a descendant of A.
273 In a fast-forward update from A to B, the set of commits that the original
274 commit A built on top of is a subset of the commits the new commit B
275 builds on top of. Hence, it does not lose any history.
277 In contrast, a non-fast-forward update will lose history. For example,
278 suppose you and somebody else started at the same commit X, and you built
279 a history leading to commit B while the other person built a history
280 leading to commit A. The history looks like this:
290 Further suppose that the other person already pushed changes leading to A
291 back to the original repository from which you two obtained the original
294 The push done by the other person updated the branch that used to point at
295 commit X to point at commit A. It is a fast-forward.
297 But if you try to push, you will attempt to update the branch (that
298 now points at A) with commit B. This does _not_ fast-forward. If you did
299 so, the changes introduced by commit A will be lost, because everybody
300 will now start building on top of B.
302 The command by default does not allow an update that is not a fast-forward
303 to prevent such loss of history.
305 If you do not want to lose your work (history from X to B) nor the work by
306 the other person (history from X to A), you would need to first fetch the
307 history from the repository, create a history that contains changes done
308 by both parties, and push the result back.
310 You can perform "git pull", resolve potential conflicts, and "git push"
311 the result. A "git pull" will create a merge commit C between commits A
322 Updating A with the resulting merge commit will fast-forward and your
323 push will be accepted.
325 Alternatively, you can rebase your change between X and B on top of A,
326 with "git pull --rebase", and push the result back. The rebase will
327 create a new commit D that builds the change between X and B on top of
338 Again, updating A with this commit will fast-forward and your push will be
341 There is another common situation where you may encounter non-fast-forward
342 rejection when you try to push, and it is possible even when you are
343 pushing into a repository nobody else pushes into. After you push commit
344 A yourself (in the first picture in this section), replace it with "git
345 commit --amend" to produce commit B, and you try to push it out, because
346 forgot that you have pushed A out already. In such a case, and only if
347 you are certain that nobody in the meantime fetched your earlier commit A
348 (and started building on top of it), you can run "git push --force" to
349 overwrite it. In other words, "git push --force" is a method reserved for
350 a case where you do mean to lose history.
357 Works like `git push <remote>`, where <remote> is the
358 current branch's remote (or `origin`, if no remote is
359 configured for the current branch).
362 Without additional configuration, works like
365 The default behavior of this command when no <refspec> is given can be
366 configured by setting the `push` option of the remote, or the `push.default`
367 configuration variable.
369 For example, to default to pushing only the current branch to `origin`
370 use `git config remote.origin.push HEAD`. Any valid <refspec> (like
371 the ones in the examples below) can be configured as the default for
374 `git push origin :`::
375 Push "matching" branches to `origin`. See
376 <refspec> in the <<OPTIONS,OPTIONS>> section above for a
377 description of "matching" branches.
379 `git push origin master`::
380 Find a ref that matches `master` in the source repository
381 (most likely, it would find `refs/heads/master`), and update
382 the same ref (e.g. `refs/heads/master`) in `origin` repository
383 with it. If `master` did not exist remotely, it would be
386 `git push origin HEAD`::
387 A handy way to push the current branch to the same name on the
390 `git push mothership master:satellite/master dev:satellite/dev`::
391 Use the source ref that matches `master` (e.g. `refs/heads/master`)
392 to update the ref that matches `satellite/master` (most probably
393 `refs/remotes/satellite/master`) in the `mothership` repository;
394 do the same for `dev` and `satellite/dev`.
396 This is to emulate `git fetch` run on the `mothership` using `git
397 push` that is run in the opposite direction in order to integrate
398 the work done on `satellite`, and is often necessary when you can
399 only make connection in one way (i.e. satellite can ssh into
400 mothership but mothership cannot initiate connection to satellite
401 because the latter is behind a firewall or does not run sshd).
403 After running this `git push` on the `satellite` machine, you would
404 ssh into the `mothership` and run `git merge` there to complete the
405 emulation of `git pull` that were run on `mothership` to pull changes
408 `git push origin HEAD:master`::
409 Push the current branch to the remote ref matching `master` in the
410 `origin` repository. This form is convenient to push the current
411 branch without thinking about its local name.
413 `git push origin master:refs/heads/experimental`::
414 Create the branch `experimental` in the `origin` repository
415 by copying the current `master` branch. This form is only
416 needed to create a new branch or tag in the remote repository when
417 the local name and the remote name are different; otherwise,
418 the ref name on its own will work.
420 `git push origin :experimental`::
421 Find a ref that matches `experimental` in the `origin` repository
422 (e.g. `refs/heads/experimental`), and delete it.
424 `git push origin +dev:master`::
425 Update the origin repository's master branch with the dev branch,
426 allowing non-fast-forward updates. *This can leave unreferenced
427 commits dangling in the origin repository.* Consider the
428 following situation, where a fast-forward is not possible:
431 o---o---o---A---B origin/master
436 The above command would change the origin repository to
439 A---B (unnamed branch)
441 o---o---o---X---Y---Z master
444 Commits A and B would no longer belong to a branch with a symbolic name,
445 and so would be unreachable. As such, these commits would be removed by
446 a `git gc` command on the origin repository.
450 Part of the linkgit:git[1] suite