6 git-push - Update remote refs along with associated objects
12 'git push' [--all | --mirror | --tags] [--follow-tags] [--atomic] [-n | --dry-run] [--receive-pack=<git-receive-pack>]
13 [--repo=<repository>] [-f | --force] [-d | --delete] [--prune] [-v | --verbose]
14 [-u | --set-upstream] [-o <string> | --push-option=<string>]
15 [--[no-]signed|--signed=(true|false|if-asked)]
16 [--force-with-lease[=<refname>[:<expect>]] [--force-if-includes]]
17 [--no-verify] [<repository> [<refspec>...]]
22 Updates remote refs using local refs, while sending objects
23 necessary to complete the given refs.
25 You can make interesting things happen to a repository
26 every time you push into it, by setting up 'hooks' there. See
27 documentation for linkgit:git-receive-pack[1].
29 When the command line does not specify where to push with the
30 `<repository>` argument, `branch.*.remote` configuration for the
31 current branch is consulted to determine where to push. If the
32 configuration is missing, it defaults to 'origin'.
34 When the command line does not specify what to push with `<refspec>...`
35 arguments or `--all`, `--mirror`, `--tags` options, the command finds
36 the default `<refspec>` by consulting `remote.*.push` configuration,
37 and if it is not found, honors `push.default` configuration to decide
38 what to push (See linkgit:git-config[1] for the meaning of `push.default`).
40 When neither the command-line nor the configuration specify what to
41 push, the default behavior is used, which corresponds to the `simple`
42 value for `push.default`: the current branch is pushed to the
43 corresponding upstream branch, but as a safety measure, the push is
44 aborted if the upstream branch does not have the same name as the
51 The "remote" repository that is destination of a push
52 operation. This parameter can be either a URL
53 (see the section <<URLS,GIT URLS>> below) or the name
54 of a remote (see the section <<REMOTES,REMOTES>> below).
57 Specify what destination ref to update with what source object.
58 The format of a <refspec> parameter is an optional plus
59 `+`, followed by the source object <src>, followed
60 by a colon `:`, followed by the destination ref <dst>.
62 The <src> is often the name of the branch you would want to push, but
63 it can be any arbitrary "SHA-1 expression", such as `master~4` or
64 `HEAD` (see linkgit:gitrevisions[7]).
66 The <dst> tells which ref on the remote side is updated with this
67 push. Arbitrary expressions cannot be used here, an actual ref must
69 If `git push [<repository>]` without any `<refspec>` argument is set to
70 update some ref at the destination with `<src>` with
71 `remote.<repository>.push` configuration variable, `:<dst>` part can
72 be omitted--such a push will update a ref that `<src>` normally updates
73 without any `<refspec>` on the command line. Otherwise, missing
74 `:<dst>` means to update the same ref as the `<src>`.
76 If <dst> doesn't start with `refs/` (e.g. `refs/heads/master`) we will
77 try to infer where in `refs/*` on the destination <repository> it
78 belongs based on the type of <src> being pushed and whether <dst>
82 * If <dst> unambiguously refers to a ref on the <repository> remote,
83 then push to that ref.
85 * If <src> resolves to a ref starting with refs/heads/ or refs/tags/,
86 then prepend that to <dst>.
88 * Other ambiguity resolutions might be added in the future, but for
89 now any other cases will error out with an error indicating what we
90 tried, and depending on the `advice.pushUnqualifiedRefname`
91 configuration (see linkgit:git-config[1]) suggest what refs/
92 namespace you may have wanted to push to.
96 The object referenced by <src> is used to update the <dst> reference
97 on the remote side. Whether this is allowed depends on where in
98 `refs/*` the <dst> reference lives as described in detail below, in
99 those sections "update" means any modifications except deletes, which
100 as noted after the next few sections are treated differently.
102 The `refs/heads/*` namespace will only accept commit objects, and
103 updates only if they can be fast-forwarded.
105 The `refs/tags/*` namespace will accept any kind of object (as
106 commits, trees and blobs can be tagged), and any updates to them will
109 It's possible to push any type of object to any namespace outside of
110 `refs/{tags,heads}/*`. In the case of tags and commits, these will be
111 treated as if they were the commits inside `refs/heads/*` for the
112 purposes of whether the update is allowed.
114 I.e. a fast-forward of commits and tags outside `refs/{tags,heads}/*`
115 is allowed, even in cases where what's being fast-forwarded is not a
116 commit, but a tag object which happens to point to a new commit which
117 is a fast-forward of the commit the last tag (or commit) it's
118 replacing. Replacing a tag with an entirely different tag is also
119 allowed, if it points to the same commit, as well as pushing a peeled
120 tag, i.e. pushing the commit that existing tag object points to, or a
121 new tag object which an existing commit points to.
123 Tree and blob objects outside of `refs/{tags,heads}/*` will be treated
124 the same way as if they were inside `refs/tags/*`, any update of them
127 All of the rules described above about what's not allowed as an update
128 can be overridden by adding an the optional leading `+` to a refspec
129 (or using `--force` command line option). The only exception to this
130 is that no amount of forcing will make the `refs/heads/*` namespace
131 accept a non-commit object. Hooks and configuration can also override
132 or amend these rules, see e.g. `receive.denyNonFastForwards` in
133 linkgit:git-config[1] and `pre-receive` and `update` in
136 Pushing an empty <src> allows you to delete the <dst> ref from the
137 remote repository. Deletions are always accepted without a leading `+`
138 in the refspec (or `--force`), except when forbidden by configuration
139 or hooks. See `receive.denyDeletes` in linkgit:git-config[1] and
140 `pre-receive` and `update` in linkgit:githooks[5].
142 The special refspec `:` (or `+:` to allow non-fast-forward updates)
143 directs Git to push "matching" branches: for every branch that exists on
144 the local side, the remote side is updated if a branch of the same name
145 already exists on the remote side.
147 `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
150 Push all branches (i.e. refs under `refs/heads/`); cannot be
151 used with other <refspec>.
154 Remove remote branches that don't have a local counterpart. For example
155 a remote branch `tmp` will be removed if a local branch with the same
156 name doesn't exist any more. This also respects refspecs, e.g.
157 `git push --prune remote refs/heads/*:refs/tmp/*` would
158 make sure that remote `refs/tmp/foo` will be removed if `refs/heads/foo`
162 Instead of naming each ref to push, specifies that all
163 refs under `refs/` (which includes but is not
164 limited to `refs/heads/`, `refs/remotes/`, and `refs/tags/`)
165 be mirrored to the remote repository. Newly created local
166 refs will be pushed to the remote end, locally updated refs
167 will be force updated on the remote end, and deleted refs
168 will be removed from the remote end. This is the default
169 if the configuration option `remote.<remote>.mirror` is
174 Do everything except actually send the updates.
177 Produce machine-readable output. The output status line for each ref
178 will be tab-separated and sent to stdout instead of stderr. The full
179 symbolic names of the refs will be given.
183 All listed refs are deleted from the remote repository. This is
184 the same as prefixing all refs with a colon.
187 All refs under `refs/tags` are pushed, in
188 addition to refspecs explicitly listed on the command
192 Push all the refs that would be pushed without this option,
193 and also push annotated tags in `refs/tags` that are missing
194 from the remote but are pointing at commit-ish that are
195 reachable from the refs being pushed. This can also be specified
196 with configuration variable `push.followTags`. For more
197 information, see `push.followTags` in linkgit:git-config[1].
200 --signed=(true|false|if-asked)::
201 GPG-sign the push request to update refs on the receiving
202 side, to allow it to be checked by the hooks and/or be
203 logged. If `false` or `--no-signed`, no signing will be
204 attempted. If `true` or `--signed`, the push will fail if the
205 server does not support signed pushes. If set to `if-asked`,
206 sign if and only if the server supports signed pushes. The push
207 will also fail if the actual call to `gpg --sign` fails. See
208 linkgit:git-receive-pack[1] for the details on the receiving end.
211 Use an atomic transaction on the remote side if available.
212 Either all refs are updated, or on error, no refs are updated.
213 If the server does not support atomic pushes the push will fail.
216 --push-option=<option>::
217 Transmit the given string to the server, which passes them to
218 the pre-receive as well as the post-receive hook. The given string
219 must not contain a NUL or LF character.
220 When multiple `--push-option=<option>` are given, they are
221 all sent to the other side in the order listed on the
223 When no `--push-option=<option>` is given from the command
224 line, the values of configuration variable `push.pushOption`
227 --receive-pack=<git-receive-pack>::
228 --exec=<git-receive-pack>::
229 Path to the 'git-receive-pack' program on the remote
230 end. Sometimes useful when pushing to a remote
231 repository over ssh, and you do not have the program in
232 a directory on the default $PATH.
234 --[no-]force-with-lease::
235 --force-with-lease=<refname>::
236 --force-with-lease=<refname>:<expect>::
237 Usually, "git push" refuses to update a remote ref that is
238 not an ancestor of the local ref used to overwrite it.
240 This option overrides this restriction if the current value of the
241 remote ref is the expected value. "git push" fails otherwise.
243 Imagine that you have to rebase what you have already published.
244 You will have to bypass the "must fast-forward" rule in order to
245 replace the history you originally published with the rebased history.
246 If somebody else built on top of your original history while you are
247 rebasing, the tip of the branch at the remote may advance with their
248 commit, and blindly pushing with `--force` will lose their work.
250 This option allows you to say that you expect the history you are
251 updating is what you rebased and want to replace. If the remote ref
252 still points at the commit you specified, you can be sure that no
253 other people did anything to the ref. It is like taking a "lease" on
254 the ref without explicitly locking it, and the remote ref is updated
255 only if the "lease" is still valid.
257 `--force-with-lease` alone, without specifying the details, will protect
258 all remote refs that are going to be updated by requiring their
259 current value to be the same as the remote-tracking branch we have
262 `--force-with-lease=<refname>`, without specifying the expected value, will
263 protect the named ref (alone), if it is going to be updated, by
264 requiring its current value to be the same as the remote-tracking
265 branch we have for it.
267 `--force-with-lease=<refname>:<expect>` will protect the named ref (alone),
268 if it is going to be updated, by requiring its current value to be
269 the same as the specified value `<expect>` (which is allowed to be
270 different from the remote-tracking branch we have for the refname,
271 or we do not even have to have such a remote-tracking branch when
272 this form is used). If `<expect>` is the empty string, then the named ref
273 must not already exist.
275 Note that all forms other than `--force-with-lease=<refname>:<expect>`
276 that specifies the expected current value of the ref explicitly are
277 still experimental and their semantics may change as we gain experience
280 "--no-force-with-lease" will cancel all the previous --force-with-lease on the
283 A general note on safety: supplying this option without an expected
284 value, i.e. as `--force-with-lease` or `--force-with-lease=<refname>`
285 interacts very badly with anything that implicitly runs `git fetch` on
286 the remote to be pushed to in the background, e.g. `git fetch origin`
287 on your repository in a cronjob.
289 The protection it offers over `--force` is ensuring that subsequent
290 changes your work wasn't based on aren't clobbered, but this is
291 trivially defeated if some background process is updating refs in the
292 background. We don't have anything except the remote tracking info to
293 go by as a heuristic for refs you're expected to have seen & are
296 If your editor or some other system is running `git fetch` in the
297 background for you a way to mitigate this is to simply set up another
300 git remote add origin-push $(git config remote.origin.url)
301 git fetch origin-push
303 Now when the background process runs `git fetch origin` the references
304 on `origin-push` won't be updated, and thus commands like:
306 git push --force-with-lease origin-push
308 Will fail unless you manually run `git fetch origin-push`. This method
309 is of course entirely defeated by something that runs `git fetch
310 --all`, in that case you'd need to either disable it or do something
313 git fetch # update 'master' from remote
314 git tag base master # mark our base point
315 git rebase -i master # rewrite some commits
316 git push --force-with-lease=master:base master:master
318 I.e. create a `base` tag for versions of the upstream code that you've
319 seen and are willing to overwrite, then rewrite history, and finally
320 force push changes to `master` if the remote version is still at
321 `base`, regardless of what your local `remotes/origin/master` has been
322 updated to in the background.
324 Alternatively, specifying `--force-if-includes` as an ancillary option
325 along with `--force-with-lease[=<refname>]` (i.e., without saying what
326 exact commit the ref on the remote side must be pointing at, or which
327 refs on the remote side are being protected) at the time of "push" will
328 verify if updates from the remote-tracking refs that may have been
329 implicitly updated in the background are integrated locally before
330 allowing a forced update.
334 Usually, the command refuses to update a remote ref that is
335 not an ancestor of the local ref used to overwrite it.
336 Also, when `--force-with-lease` option is used, the command refuses
337 to update a remote ref whose current value does not match
340 This flag disables these checks, and can cause the remote repository
341 to lose commits; use it with care.
343 Note that `--force` applies to all the refs that are pushed, hence
344 using it with `push.default` set to `matching` or with multiple push
345 destinations configured with `remote.*.push` may overwrite refs
346 other than the current branch (including local refs that are
347 strictly behind their remote counterpart). To force a push to only
348 one branch, use a `+` in front of the refspec to push (e.g `git push
349 origin +master` to force a push to the `master` branch). See the
350 `<refspec>...` section above for details.
352 --[no-]force-if-includes::
353 Force an update only if the tip of the remote-tracking ref
354 has been integrated locally.
356 This option enables a check that verifies if the tip of the
357 remote-tracking ref is reachable from one of the "reflog" entries of
358 the local branch based in it for a rewrite. The check ensures that any
359 updates from the remote have been incorporated locally by rejecting the
360 forced update if that is not the case.
362 If the option is passed without specifying `--force-with-lease`, or
363 specified along with `--force-with-lease=<refname>:<expect>`, it is
366 Specifying `--no-force-if-includes` disables this behavior.
368 --repo=<repository>::
369 This option is equivalent to the <repository> argument. If both
370 are specified, the command-line argument takes precedence.
374 For every branch that is up to date or successfully pushed, add
375 upstream (tracking) reference, used by argument-less
376 linkgit:git-pull[1] and other commands. For more information,
377 see `branch.<name>.merge` in linkgit:git-config[1].
380 These options are passed to linkgit:git-send-pack[1]. A thin transfer
381 significantly reduces the amount of sent data when the sender and
382 receiver share many of the same objects in common. The default is
387 Suppress all output, including the listing of updated refs,
388 unless an error occurs. Progress is not reported to the standard
396 Progress status is reported on the standard error stream
397 by default when it is attached to a terminal, unless -q
398 is specified. This flag forces progress status even if the
399 standard error stream is not directed to a terminal.
401 --no-recurse-submodules::
402 --recurse-submodules=check|on-demand|only|no::
403 May be used to make sure all submodule commits used by the
404 revisions to be pushed are available on a remote-tracking branch.
405 If 'check' is used Git will verify that all submodule commits that
406 changed in the revisions to be pushed are available on at least one
407 remote of the submodule. If any commits are missing the push will
408 be aborted and exit with non-zero status. If 'on-demand' is used
409 all submodules that changed in the revisions to be pushed will be
410 pushed. If on-demand was not able to push all necessary revisions it will
411 also be aborted and exit with non-zero status. If 'only' is used all
412 submodules will be recursively pushed while the superproject is left
413 unpushed. A value of 'no' or using `--no-recurse-submodules` can be used
414 to override the push.recurseSubmodules configuration variable when no
415 submodule recursion is required.
418 Toggle the pre-push hook (see linkgit:githooks[5]). The
419 default is --verify, giving the hook a chance to prevent the
420 push. With --no-verify, the hook is bypassed completely.
424 Use IPv4 addresses only, ignoring IPv6 addresses.
428 Use IPv6 addresses only, ignoring IPv4 addresses.
430 include::urls-remotes.txt[]
435 The output of "git push" depends on the transport method used; this
436 section describes the output when pushing over the Git protocol (either
439 The status of the push is output in tabular form, with each line
440 representing the status of a single ref. Each line is of the form:
442 -------------------------------
443 <flag> <summary> <from> -> <to> (<reason>)
444 -------------------------------
446 If --porcelain is used, then each line of the output is of the form:
448 -------------------------------
449 <flag> \t <from>:<to> \t <summary> (<reason>)
450 -------------------------------
452 The status of up-to-date refs is shown only if --porcelain or --verbose
456 A single character indicating the status of the ref:
457 (space);; for a successfully pushed fast-forward;
458 `+`;; for a successful forced update;
459 `-`;; for a successfully deleted ref;
460 `*`;; for a successfully pushed new ref;
461 `!`;; for a ref that was rejected or failed to push; and
462 `=`;; for a ref that was up to date and did not need pushing.
465 For a successfully pushed ref, the summary shows the old and new
466 values of the ref in a form suitable for using as an argument to
467 `git log` (this is `<old>..<new>` in most cases, and
468 `<old>...<new>` for forced non-fast-forward updates).
470 For a failed update, more details are given:
474 Git did not try to send the ref at all, typically because it
475 is not a fast-forward and you did not force the update.
478 The remote end refused the update. Usually caused by a hook
479 on the remote side, or because the remote repository has one
480 of the following safety options in effect:
481 `receive.denyCurrentBranch` (for pushes to the checked out
482 branch), `receive.denyNonFastForwards` (for forced
483 non-fast-forward updates), `receive.denyDeletes` or
484 `receive.denyDeleteCurrent`. See linkgit:git-config[1].
487 The remote end did not report the successful update of the ref,
488 perhaps because of a temporary error on the remote side, a
489 break in the network connection, or other transient error.
493 The name of the local ref being pushed, minus its
494 `refs/<type>/` prefix. In the case of deletion, the
495 name of the local ref is omitted.
498 The name of the remote ref being updated, minus its
499 `refs/<type>/` prefix.
502 A human-readable explanation. In the case of successfully pushed
503 refs, no explanation is needed. For a failed ref, the reason for
504 failure is described.
506 NOTE ABOUT FAST-FORWARDS
507 ------------------------
509 When an update changes a branch (or more in general, a ref) that used to
510 point at commit A to point at another commit B, it is called a
511 fast-forward update if and only if B is a descendant of A.
513 In a fast-forward update from A to B, the set of commits that the original
514 commit A built on top of is a subset of the commits the new commit B
515 builds on top of. Hence, it does not lose any history.
517 In contrast, a non-fast-forward update will lose history. For example,
518 suppose you and somebody else started at the same commit X, and you built
519 a history leading to commit B while the other person built a history
520 leading to commit A. The history looks like this:
530 Further suppose that the other person already pushed changes leading to A
531 back to the original repository from which you two obtained the original
534 The push done by the other person updated the branch that used to point at
535 commit X to point at commit A. It is a fast-forward.
537 But if you try to push, you will attempt to update the branch (that
538 now points at A) with commit B. This does _not_ fast-forward. If you did
539 so, the changes introduced by commit A will be lost, because everybody
540 will now start building on top of B.
542 The command by default does not allow an update that is not a fast-forward
543 to prevent such loss of history.
545 If you do not want to lose your work (history from X to B) or the work by
546 the other person (history from X to A), you would need to first fetch the
547 history from the repository, create a history that contains changes done
548 by both parties, and push the result back.
550 You can perform "git pull", resolve potential conflicts, and "git push"
551 the result. A "git pull" will create a merge commit C between commits A
562 Updating A with the resulting merge commit will fast-forward and your
563 push will be accepted.
565 Alternatively, you can rebase your change between X and B on top of A,
566 with "git pull --rebase", and push the result back. The rebase will
567 create a new commit D that builds the change between X and B on top of
578 Again, updating A with this commit will fast-forward and your push will be
581 There is another common situation where you may encounter non-fast-forward
582 rejection when you try to push, and it is possible even when you are
583 pushing into a repository nobody else pushes into. After you push commit
584 A yourself (in the first picture in this section), replace it with "git
585 commit --amend" to produce commit B, and you try to push it out, because
586 forgot that you have pushed A out already. In such a case, and only if
587 you are certain that nobody in the meantime fetched your earlier commit A
588 (and started building on top of it), you can run "git push --force" to
589 overwrite it. In other words, "git push --force" is a method reserved for
590 a case where you do mean to lose history.
597 Works like `git push <remote>`, where <remote> is the
598 current branch's remote (or `origin`, if no remote is
599 configured for the current branch).
602 Without additional configuration, pushes the current branch to
603 the configured upstream (`branch.<name>.merge` configuration
604 variable) if it has the same name as the current branch, and
605 errors out without pushing otherwise.
607 The default behavior of this command when no <refspec> is given can be
608 configured by setting the `push` option of the remote, or the `push.default`
609 configuration variable.
611 For example, to default to pushing only the current branch to `origin`
612 use `git config remote.origin.push HEAD`. Any valid <refspec> (like
613 the ones in the examples below) can be configured as the default for
616 `git push origin :`::
617 Push "matching" branches to `origin`. See
618 <refspec> in the <<OPTIONS,OPTIONS>> section above for a
619 description of "matching" branches.
621 `git push origin master`::
622 Find a ref that matches `master` in the source repository
623 (most likely, it would find `refs/heads/master`), and update
624 the same ref (e.g. `refs/heads/master`) in `origin` repository
625 with it. If `master` did not exist remotely, it would be
628 `git push origin HEAD`::
629 A handy way to push the current branch to the same name on the
632 `git push mothership master:satellite/master dev:satellite/dev`::
633 Use the source ref that matches `master` (e.g. `refs/heads/master`)
634 to update the ref that matches `satellite/master` (most probably
635 `refs/remotes/satellite/master`) in the `mothership` repository;
636 do the same for `dev` and `satellite/dev`.
638 See the section describing `<refspec>...` above for a discussion of
639 the matching semantics.
641 This is to emulate `git fetch` run on the `mothership` using `git
642 push` that is run in the opposite direction in order to integrate
643 the work done on `satellite`, and is often necessary when you can
644 only make connection in one way (i.e. satellite can ssh into
645 mothership but mothership cannot initiate connection to satellite
646 because the latter is behind a firewall or does not run sshd).
648 After running this `git push` on the `satellite` machine, you would
649 ssh into the `mothership` and run `git merge` there to complete the
650 emulation of `git pull` that were run on `mothership` to pull changes
653 `git push origin HEAD:master`::
654 Push the current branch to the remote ref matching `master` in the
655 `origin` repository. This form is convenient to push the current
656 branch without thinking about its local name.
658 `git push origin master:refs/heads/experimental`::
659 Create the branch `experimental` in the `origin` repository
660 by copying the current `master` branch. This form is only
661 needed to create a new branch or tag in the remote repository when
662 the local name and the remote name are different; otherwise,
663 the ref name on its own will work.
665 `git push origin :experimental`::
666 Find a ref that matches `experimental` in the `origin` repository
667 (e.g. `refs/heads/experimental`), and delete it.
669 `git push origin +dev:master`::
670 Update the origin repository's master branch with the dev branch,
671 allowing non-fast-forward updates. *This can leave unreferenced
672 commits dangling in the origin repository.* Consider the
673 following situation, where a fast-forward is not possible:
676 o---o---o---A---B origin/master
681 The above command would change the origin repository to
684 A---B (unnamed branch)
686 o---o---o---X---Y---Z master
689 Commits A and B would no longer belong to a branch with a symbolic name,
690 and so would be unreachable. As such, these commits would be removed by
691 a `git gc` command on the origin repository.
693 include::transfer-data-leaks.txt[]
697 Part of the linkgit:git[1] suite