6 git-push - Update remote refs along with associated objects
12 'git push' [--all | --mirror | --tags] [--follow-tags] [-n | --dry-run] [--receive-pack=<git-receive-pack>]
13 [--repo=<repository>] [-f | --force] [--prune] [-v | --verbose] [-u | --set-upstream]
14 [--force-with-lease[=<refname>[:<expect>]]]
15 [--no-verify] [<repository> [<refspec>...]]
20 Updates remote refs using local refs, while sending objects
21 necessary to complete the given refs.
23 You can make interesting things happen to a repository
24 every time you push into it, by setting up 'hooks' there. See
25 documentation for linkgit:git-receive-pack[1].
27 When the command line does not specify where to push with the
28 `<repository>` argument, `branch.*.remote` configuration for the
29 current branch is consulted to determine where to push. If the
30 configuration is missing, it defaults to 'origin'.
32 When the command line does not specify what to push with `<refspec>...`
33 arguments or `--all`, `--mirror`, `--tags` options, the command finds
34 the default `<refspec>` by consulting `remote.*.push` configuration,
35 and if it is not found, honors `push.default` configuration to decide
36 what to push (See gitlink:git-config[1] for the meaning of `push.default`).
42 The "remote" repository that is destination of a push
43 operation. This parameter can be either a URL
44 (see the section <<URLS,GIT URLS>> below) or the name
45 of a remote (see the section <<REMOTES,REMOTES>> below).
48 Specify what destination ref to update with what source object.
49 The format of a <refspec> parameter is an optional plus
50 `+`, followed by the source object <src>, followed
51 by a colon `:`, followed by the destination ref <dst>.
53 The <src> is often the name of the branch you would want to push, but
54 it can be any arbitrary "SHA-1 expression", such as `master~4` or
55 `HEAD` (see linkgit:gitrevisions[7]).
57 The <dst> tells which ref on the remote side is updated with this
58 push. Arbitrary expressions cannot be used here, an actual ref must
60 If `git push [<repository>]` without any `<refspec>` argument is set to
61 update some ref at the destination with `<src>` with
62 `remote.<repository>.push` configuration variable, `:<dst>` part can
63 be omitted---such a push will update a ref that `<src>` normally updates
64 without any `<refspec>` on the command line. Otherwise, missing
65 `:<dst>` means to update the same ref as the `<src>`.
67 The object referenced by <src> is used to update the <dst> reference
68 on the remote side. By default this is only allowed if <dst> is not
69 a tag (annotated or lightweight), and then only if it can fast-forward
70 <dst>. By having the optional leading `+`, you can tell Git to update
71 the <dst> ref even if it is not allowed by default (e.g., it is not a
72 fast-forward.) This does *not* attempt to merge <src> into <dst>. See
73 EXAMPLES below for details.
75 `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
77 Pushing an empty <src> allows you to delete the <dst> ref from
78 the remote repository.
80 The special refspec `:` (or `+:` to allow non-fast-forward updates)
81 directs Git to push "matching" branches: for every branch that exists on
82 the local side, the remote side is updated if a branch of the same name
83 already exists on the remote side.
86 Push all branches (i.e. refs under `refs/heads/`); cannot be
87 used with other <refspec>.
90 Remove remote branches that don't have a local counterpart. For example
91 a remote branch `tmp` will be removed if a local branch with the same
92 name doesn't exist any more. This also respects refspecs, e.g.
93 `git push --prune remote refs/heads/*:refs/tmp/*` would
94 make sure that remote `refs/tmp/foo` will be removed if `refs/heads/foo`
98 Instead of naming each ref to push, specifies that all
99 refs under `refs/` (which includes but is not
100 limited to `refs/heads/`, `refs/remotes/`, and `refs/tags/`)
101 be mirrored to the remote repository. Newly created local
102 refs will be pushed to the remote end, locally updated refs
103 will be force updated on the remote end, and deleted refs
104 will be removed from the remote end. This is the default
105 if the configuration option `remote.<remote>.mirror` is
110 Do everything except actually send the updates.
113 Produce machine-readable output. The output status line for each ref
114 will be tab-separated and sent to stdout instead of stderr. The full
115 symbolic names of the refs will be given.
118 All listed refs are deleted from the remote repository. This is
119 the same as prefixing all refs with a colon.
122 All refs under `refs/tags` are pushed, in
123 addition to refspecs explicitly listed on the command
127 Push all the refs that would be pushed without this option,
128 and also push annotated tags in `refs/tags` that are missing
129 from the remote but are pointing at commit-ish that are
130 reachable from the refs being pushed.
132 --receive-pack=<git-receive-pack>::
133 --exec=<git-receive-pack>::
134 Path to the 'git-receive-pack' program on the remote
135 end. Sometimes useful when pushing to a remote
136 repository over ssh, and you do not have the program in
137 a directory on the default $PATH.
139 --[no-]force-with-lease::
140 --force-with-lease=<refname>::
141 --force-with-lease=<refname>:<expect>::
142 Usually, "git push" refuses to update a remote ref that is
143 not an ancestor of the local ref used to overwrite it.
145 This option bypasses the check, but instead requires that the
146 current value of the ref to be the expected value. "git push"
149 Imagine that you have to rebase what you have already published.
150 You will have to bypass the "must fast-forward" rule in order to
151 replace the history you originally published with the rebased history.
152 If somebody else built on top of your original history while you are
153 rebasing, the tip of the branch at the remote may advance with her
154 commit, and blindly pushing with `--force` will lose her work.
156 This option allows you to say that you expect the history you are
157 updating is what you rebased and want to replace. If the remote ref
158 still points at the commit you specified, you can be sure that no
159 other people did anything to the ref (it is like taking a "lease" on
160 the ref without explicitly locking it, and you update the ref while
161 making sure that your earlier "lease" is still valid).
163 `--force-with-lease` alone, without specifying the details, will protect
164 all remote refs that are going to be updated by requiring their
165 current value to be the same as the remote-tracking branch we have
166 for them, unless specified with a `--force-with-lease=<refname>:<expect>`
167 option that explicitly states what the expected value is.
169 `--force-with-lease=<refname>`, without specifying the expected value, will
170 protect the named ref (alone), if it is going to be updated, by
171 requiring its current value to be the same as the remote-tracking
172 branch we have for it.
174 `--force-with-lease=<refname>:<expect>` will protect the named ref (alone),
175 if it is going to be updated, by requiring its current value to be
176 the same as the specified value <expect> (which is allowed to be
177 different from the remote-tracking branch we have for the refname,
178 or we do not even have to have such a remote-tracking branch when
181 Note that all forms other than `--force-with-lease=<refname>:<expect>`
182 that specifies the expected current value of the ref explicitly are
183 still experimental and their semantics may change as we gain experience
186 "--no-force-with-lease" will cancel all the previous --force-with-lease on the
191 Usually, the command refuses to update a remote ref that is
192 not an ancestor of the local ref used to overwrite it.
193 Also, when `--force-with-lease` option is used, the command refuses
194 to update a remote ref whose current value does not match
197 This flag disables these checks, and can cause the remote repository
198 to lose commits; use it with care.
200 Note that `--force` applies to all the refs that are pushed, hence
201 using it with `push.default` set to `matching` or with multiple push
202 destinations configured with `remote.*.push` may overwrite refs
203 other than the current branch (including local refs that are
204 strictly behind their remote counterpart). To force a push to only
205 one branch, use a `+` in front of the refspec to push (e.g `git push
206 origin +master` to force a push to the `master` branch). See the
207 `<refspec>...` section above for details.
209 --repo=<repository>::
210 This option is equivalent to the <repository> argument. If both
211 are specified, the command-line argument takes precedence.
215 For every branch that is up to date or successfully pushed, add
216 upstream (tracking) reference, used by argument-less
217 linkgit:git-pull[1] and other commands. For more information,
218 see 'branch.<name>.merge' in linkgit:git-config[1].
221 These options are passed to linkgit:git-send-pack[1]. A thin transfer
222 significantly reduces the amount of sent data when the sender and
223 receiver share many of the same objects in common. The default is
228 Suppress all output, including the listing of updated refs,
229 unless an error occurs. Progress is not reported to the standard
237 Progress status is reported on the standard error stream
238 by default when it is attached to a terminal, unless -q
239 is specified. This flag forces progress status even if the
240 standard error stream is not directed to a terminal.
242 --recurse-submodules=check|on-demand::
243 Make sure all submodule commits used by the revisions to be
244 pushed are available on a remote-tracking branch. If 'check' is
245 used Git will verify that all submodule commits that changed in
246 the revisions to be pushed are available on at least one remote
247 of the submodule. If any commits are missing the push will be
248 aborted and exit with non-zero status. If 'on-demand' is used
249 all submodules that changed in the revisions to be pushed will
250 be pushed. If on-demand was not able to push all necessary
251 revisions it will also be aborted and exit with non-zero status.
254 Toggle the pre-push hook (see linkgit:githooks[5]). The
255 default is \--verify, giving the hook a chance to prevent the
256 push. With \--no-verify, the hook is bypassed completely.
259 include::urls-remotes.txt[]
264 The output of "git push" depends on the transport method used; this
265 section describes the output when pushing over the Git protocol (either
268 The status of the push is output in tabular form, with each line
269 representing the status of a single ref. Each line is of the form:
271 -------------------------------
272 <flag> <summary> <from> -> <to> (<reason>)
273 -------------------------------
275 If --porcelain is used, then each line of the output is of the form:
277 -------------------------------
278 <flag> \t <from>:<to> \t <summary> (<reason>)
279 -------------------------------
281 The status of up-to-date refs is shown only if --porcelain or --verbose
285 A single character indicating the status of the ref:
286 (space);; for a successfully pushed fast-forward;
287 `+`;; for a successful forced update;
288 `-`;; for a successfully deleted ref;
289 `*`;; for a successfully pushed new ref;
290 `!`;; for a ref that was rejected or failed to push; and
291 `=`;; for a ref that was up to date and did not need pushing.
294 For a successfully pushed ref, the summary shows the old and new
295 values of the ref in a form suitable for using as an argument to
296 `git log` (this is `<old>..<new>` in most cases, and
297 `<old>...<new>` for forced non-fast-forward updates).
299 For a failed update, more details are given:
303 Git did not try to send the ref at all, typically because it
304 is not a fast-forward and you did not force the update.
307 The remote end refused the update. Usually caused by a hook
308 on the remote side, or because the remote repository has one
309 of the following safety options in effect:
310 `receive.denyCurrentBranch` (for pushes to the checked out
311 branch), `receive.denyNonFastForwards` (for forced
312 non-fast-forward updates), `receive.denyDeletes` or
313 `receive.denyDeleteCurrent`. See linkgit:git-config[1].
316 The remote end did not report the successful update of the ref,
317 perhaps because of a temporary error on the remote side, a
318 break in the network connection, or other transient error.
322 The name of the local ref being pushed, minus its
323 `refs/<type>/` prefix. In the case of deletion, the
324 name of the local ref is omitted.
327 The name of the remote ref being updated, minus its
328 `refs/<type>/` prefix.
331 A human-readable explanation. In the case of successfully pushed
332 refs, no explanation is needed. For a failed ref, the reason for
333 failure is described.
335 Note about fast-forwards
336 ------------------------
338 When an update changes a branch (or more in general, a ref) that used to
339 point at commit A to point at another commit B, it is called a
340 fast-forward update if and only if B is a descendant of A.
342 In a fast-forward update from A to B, the set of commits that the original
343 commit A built on top of is a subset of the commits the new commit B
344 builds on top of. Hence, it does not lose any history.
346 In contrast, a non-fast-forward update will lose history. For example,
347 suppose you and somebody else started at the same commit X, and you built
348 a history leading to commit B while the other person built a history
349 leading to commit A. The history looks like this:
359 Further suppose that the other person already pushed changes leading to A
360 back to the original repository from which you two obtained the original
363 The push done by the other person updated the branch that used to point at
364 commit X to point at commit A. It is a fast-forward.
366 But if you try to push, you will attempt to update the branch (that
367 now points at A) with commit B. This does _not_ fast-forward. If you did
368 so, the changes introduced by commit A will be lost, because everybody
369 will now start building on top of B.
371 The command by default does not allow an update that is not a fast-forward
372 to prevent such loss of history.
374 If you do not want to lose your work (history from X to B) or the work by
375 the other person (history from X to A), you would need to first fetch the
376 history from the repository, create a history that contains changes done
377 by both parties, and push the result back.
379 You can perform "git pull", resolve potential conflicts, and "git push"
380 the result. A "git pull" will create a merge commit C between commits A
391 Updating A with the resulting merge commit will fast-forward and your
392 push will be accepted.
394 Alternatively, you can rebase your change between X and B on top of A,
395 with "git pull --rebase", and push the result back. The rebase will
396 create a new commit D that builds the change between X and B on top of
407 Again, updating A with this commit will fast-forward and your push will be
410 There is another common situation where you may encounter non-fast-forward
411 rejection when you try to push, and it is possible even when you are
412 pushing into a repository nobody else pushes into. After you push commit
413 A yourself (in the first picture in this section), replace it with "git
414 commit --amend" to produce commit B, and you try to push it out, because
415 forgot that you have pushed A out already. In such a case, and only if
416 you are certain that nobody in the meantime fetched your earlier commit A
417 (and started building on top of it), you can run "git push --force" to
418 overwrite it. In other words, "git push --force" is a method reserved for
419 a case where you do mean to lose history.
426 Works like `git push <remote>`, where <remote> is the
427 current branch's remote (or `origin`, if no remote is
428 configured for the current branch).
431 Without additional configuration, pushes the current branch to
432 the configured upstream (`remote.origin.merge` configuration
433 variable) if it has the same name as the current branch, and
434 errors out without pushing otherwise.
436 The default behavior of this command when no <refspec> is given can be
437 configured by setting the `push` option of the remote, or the `push.default`
438 configuration variable.
440 For example, to default to pushing only the current branch to `origin`
441 use `git config remote.origin.push HEAD`. Any valid <refspec> (like
442 the ones in the examples below) can be configured as the default for
445 `git push origin :`::
446 Push "matching" branches to `origin`. See
447 <refspec> in the <<OPTIONS,OPTIONS>> section above for a
448 description of "matching" branches.
450 `git push origin master`::
451 Find a ref that matches `master` in the source repository
452 (most likely, it would find `refs/heads/master`), and update
453 the same ref (e.g. `refs/heads/master`) in `origin` repository
454 with it. If `master` did not exist remotely, it would be
457 `git push origin HEAD`::
458 A handy way to push the current branch to the same name on the
461 `git push mothership master:satellite/master dev:satellite/dev`::
462 Use the source ref that matches `master` (e.g. `refs/heads/master`)
463 to update the ref that matches `satellite/master` (most probably
464 `refs/remotes/satellite/master`) in the `mothership` repository;
465 do the same for `dev` and `satellite/dev`.
467 This is to emulate `git fetch` run on the `mothership` using `git
468 push` that is run in the opposite direction in order to integrate
469 the work done on `satellite`, and is often necessary when you can
470 only make connection in one way (i.e. satellite can ssh into
471 mothership but mothership cannot initiate connection to satellite
472 because the latter is behind a firewall or does not run sshd).
474 After running this `git push` on the `satellite` machine, you would
475 ssh into the `mothership` and run `git merge` there to complete the
476 emulation of `git pull` that were run on `mothership` to pull changes
479 `git push origin HEAD:master`::
480 Push the current branch to the remote ref matching `master` in the
481 `origin` repository. This form is convenient to push the current
482 branch without thinking about its local name.
484 `git push origin master:refs/heads/experimental`::
485 Create the branch `experimental` in the `origin` repository
486 by copying the current `master` branch. This form is only
487 needed to create a new branch or tag in the remote repository when
488 the local name and the remote name are different; otherwise,
489 the ref name on its own will work.
491 `git push origin :experimental`::
492 Find a ref that matches `experimental` in the `origin` repository
493 (e.g. `refs/heads/experimental`), and delete it.
495 `git push origin +dev:master`::
496 Update the origin repository's master branch with the dev branch,
497 allowing non-fast-forward updates. *This can leave unreferenced
498 commits dangling in the origin repository.* Consider the
499 following situation, where a fast-forward is not possible:
502 o---o---o---A---B origin/master
507 The above command would change the origin repository to
510 A---B (unnamed branch)
512 o---o---o---X---Y---Z master
515 Commits A and B would no longer belong to a branch with a symbolic name,
516 and so would be unreachable. As such, these commits would be removed by
517 a `git gc` command on the origin repository.
521 Part of the linkgit:git[1] suite