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] [--prune] [-v | --verbose]
14 [-u | --set-upstream] [--signed]
15 [--force-with-lease[=<refname>[:<expect>]]]
16 [--no-verify] [<repository> [<refspec>...]]
21 Updates remote refs using local refs, while sending objects
22 necessary to complete the given refs.
24 You can make interesting things happen to a repository
25 every time you push into it, by setting up 'hooks' there. See
26 documentation for linkgit:git-receive-pack[1].
28 When the command line does not specify where to push with the
29 `<repository>` argument, `branch.*.remote` configuration for the
30 current branch is consulted to determine where to push. If the
31 configuration is missing, it defaults to 'origin'.
33 When the command line does not specify what to push with `<refspec>...`
34 arguments or `--all`, `--mirror`, `--tags` options, the command finds
35 the default `<refspec>` by consulting `remote.*.push` configuration,
36 and if it is not found, honors `push.default` configuration to decide
37 what to push (See gitlink:git-config[1] for the meaning of `push.default`).
43 The "remote" repository that is destination of a push
44 operation. This parameter can be either a URL
45 (see the section <<URLS,GIT URLS>> below) or the name
46 of a remote (see the section <<REMOTES,REMOTES>> below).
49 Specify what destination ref to update with what source object.
50 The format of a <refspec> parameter is an optional plus
51 `+`, followed by the source object <src>, followed
52 by a colon `:`, followed by the destination ref <dst>.
54 The <src> is often the name of the branch you would want to push, but
55 it can be any arbitrary "SHA-1 expression", such as `master~4` or
56 `HEAD` (see linkgit:gitrevisions[7]).
58 The <dst> tells which ref on the remote side is updated with this
59 push. Arbitrary expressions cannot be used here, an actual ref must
61 If `git push [<repository>]` without any `<refspec>` argument is set to
62 update some ref at the destination with `<src>` with
63 `remote.<repository>.push` configuration variable, `:<dst>` part can
64 be omitted---such a push will update a ref that `<src>` normally updates
65 without any `<refspec>` on the command line. Otherwise, missing
66 `:<dst>` means to update the same ref as the `<src>`.
68 The object referenced by <src> is used to update the <dst> reference
69 on the remote side. By default this is only allowed if <dst> is not
70 a tag (annotated or lightweight), and then only if it can fast-forward
71 <dst>. By having the optional leading `+`, you can tell Git to update
72 the <dst> ref even if it is not allowed by default (e.g., it is not a
73 fast-forward.) This does *not* attempt to merge <src> into <dst>. See
74 EXAMPLES below for details.
76 `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
78 Pushing an empty <src> allows you to delete the <dst> ref from
79 the remote repository.
81 The special refspec `:` (or `+:` to allow non-fast-forward updates)
82 directs Git to push "matching" branches: for every branch that exists on
83 the local side, the remote side is updated if a branch of the same name
84 already exists on the remote side.
87 Push all branches (i.e. refs under `refs/heads/`); cannot be
88 used with other <refspec>.
91 Remove remote branches that don't have a local counterpart. For example
92 a remote branch `tmp` will be removed if a local branch with the same
93 name doesn't exist any more. This also respects refspecs, e.g.
94 `git push --prune remote refs/heads/*:refs/tmp/*` would
95 make sure that remote `refs/tmp/foo` will be removed if `refs/heads/foo`
99 Instead of naming each ref to push, specifies that all
100 refs under `refs/` (which includes but is not
101 limited to `refs/heads/`, `refs/remotes/`, and `refs/tags/`)
102 be mirrored to the remote repository. Newly created local
103 refs will be pushed to the remote end, locally updated refs
104 will be force updated on the remote end, and deleted refs
105 will be removed from the remote end. This is the default
106 if the configuration option `remote.<remote>.mirror` is
111 Do everything except actually send the updates.
114 Produce machine-readable output. The output status line for each ref
115 will be tab-separated and sent to stdout instead of stderr. The full
116 symbolic names of the refs will be given.
119 All listed refs are deleted from the remote repository. This is
120 the same as prefixing all refs with a colon.
123 All refs under `refs/tags` are pushed, in
124 addition to refspecs explicitly listed on the command
128 Push all the refs that would be pushed without this option,
129 and also push annotated tags in `refs/tags` that are missing
130 from the remote but are pointing at commit-ish that are
131 reachable from the refs being pushed.
134 GPG-sign the push request to update refs on the receiving
135 side, to allow it to be checked by the hooks and/or be
136 logged. See linkgit:git-receive-pack[1] for the details
137 on the receiving end.
140 Use an atomic transaction on the remote side if available.
141 Either all refs are updated, or on error, no refs are updated.
142 If the server does not support atomic pushes the push will fail.
144 --receive-pack=<git-receive-pack>::
145 --exec=<git-receive-pack>::
146 Path to the 'git-receive-pack' program on the remote
147 end. Sometimes useful when pushing to a remote
148 repository over ssh, and you do not have the program in
149 a directory on the default $PATH.
151 --[no-]force-with-lease::
152 --force-with-lease=<refname>::
153 --force-with-lease=<refname>:<expect>::
154 Usually, "git push" refuses to update a remote ref that is
155 not an ancestor of the local ref used to overwrite it.
157 This option bypasses the check, but instead requires that the
158 current value of the ref to be the expected value. "git push"
161 Imagine that you have to rebase what you have already published.
162 You will have to bypass the "must fast-forward" rule in order to
163 replace the history you originally published with the rebased history.
164 If somebody else built on top of your original history while you are
165 rebasing, the tip of the branch at the remote may advance with her
166 commit, and blindly pushing with `--force` will lose her work.
168 This option allows you to say that you expect the history you are
169 updating is what you rebased and want to replace. If the remote ref
170 still points at the commit you specified, you can be sure that no
171 other people did anything to the ref (it is like taking a "lease" on
172 the ref without explicitly locking it, and you update the ref while
173 making sure that your earlier "lease" is still valid).
175 `--force-with-lease` alone, without specifying the details, will protect
176 all remote refs that are going to be updated by requiring their
177 current value to be the same as the remote-tracking branch we have
178 for them, unless specified with a `--force-with-lease=<refname>:<expect>`
179 option that explicitly states what the expected value is.
181 `--force-with-lease=<refname>`, without specifying the expected value, will
182 protect the named ref (alone), if it is going to be updated, by
183 requiring its current value to be the same as the remote-tracking
184 branch we have for it.
186 `--force-with-lease=<refname>:<expect>` will protect the named ref (alone),
187 if it is going to be updated, by requiring its current value to be
188 the same as the specified value <expect> (which is allowed to be
189 different from the remote-tracking branch we have for the refname,
190 or we do not even have to have such a remote-tracking branch when
193 Note that all forms other than `--force-with-lease=<refname>:<expect>`
194 that specifies the expected current value of the ref explicitly are
195 still experimental and their semantics may change as we gain experience
198 "--no-force-with-lease" will cancel all the previous --force-with-lease on the
203 Usually, the command refuses to update a remote ref that is
204 not an ancestor of the local ref used to overwrite it.
205 Also, when `--force-with-lease` option is used, the command refuses
206 to update a remote ref whose current value does not match
209 This flag disables these checks, and can cause the remote repository
210 to lose commits; use it with care.
212 Note that `--force` applies to all the refs that are pushed, hence
213 using it with `push.default` set to `matching` or with multiple push
214 destinations configured with `remote.*.push` may overwrite refs
215 other than the current branch (including local refs that are
216 strictly behind their remote counterpart). To force a push to only
217 one branch, use a `+` in front of the refspec to push (e.g `git push
218 origin +master` to force a push to the `master` branch). See the
219 `<refspec>...` section above for details.
221 --repo=<repository>::
222 This option is only relevant if no <repository> argument is
223 passed in the invocation. In this case, 'git push' derives the
224 remote name from the current branch: If it tracks a remote
225 branch, then that remote repository is pushed to. Otherwise,
226 the name "origin" is used. For this latter case, this option
227 can be used to override the name "origin". In other words,
228 the difference between these two commands
230 --------------------------
232 git push --repo=public #2
233 --------------------------
235 is that #1 always pushes to "public" whereas #2 pushes to "public"
236 only if the current branch does not track a remote branch. This is
237 useful if you write an alias or script around 'git push'.
241 For every branch that is up to date or successfully pushed, add
242 upstream (tracking) reference, used by argument-less
243 linkgit:git-pull[1] and other commands. For more information,
244 see 'branch.<name>.merge' in linkgit:git-config[1].
247 These options are passed to linkgit:git-send-pack[1]. A thin transfer
248 significantly reduces the amount of sent data when the sender and
249 receiver share many of the same objects in common. The default is
254 Suppress all output, including the listing of updated refs,
255 unless an error occurs. Progress is not reported to the standard
263 Progress status is reported on the standard error stream
264 by default when it is attached to a terminal, unless -q
265 is specified. This flag forces progress status even if the
266 standard error stream is not directed to a terminal.
268 --recurse-submodules=check|on-demand::
269 Make sure all submodule commits used by the revisions to be
270 pushed are available on a remote-tracking branch. If 'check' is
271 used Git will verify that all submodule commits that changed in
272 the revisions to be pushed are available on at least one remote
273 of the submodule. If any commits are missing the push will be
274 aborted and exit with non-zero status. If 'on-demand' is used
275 all submodules that changed in the revisions to be pushed will
276 be pushed. If on-demand was not able to push all necessary
277 revisions it will also be aborted and exit with non-zero status.
280 Toggle the pre-push hook (see linkgit:githooks[5]). The
281 default is \--verify, giving the hook a chance to prevent the
282 push. With \--no-verify, the hook is bypassed completely.
285 include::urls-remotes.txt[]
290 The output of "git push" depends on the transport method used; this
291 section describes the output when pushing over the Git protocol (either
294 The status of the push is output in tabular form, with each line
295 representing the status of a single ref. Each line is of the form:
297 -------------------------------
298 <flag> <summary> <from> -> <to> (<reason>)
299 -------------------------------
301 If --porcelain is used, then each line of the output is of the form:
303 -------------------------------
304 <flag> \t <from>:<to> \t <summary> (<reason>)
305 -------------------------------
307 The status of up-to-date refs is shown only if --porcelain or --verbose
311 A single character indicating the status of the ref:
312 (space);; for a successfully pushed fast-forward;
313 `+`;; for a successful forced update;
314 `-`;; for a successfully deleted ref;
315 `*`;; for a successfully pushed new ref;
316 `!`;; for a ref that was rejected or failed to push; and
317 `=`;; for a ref that was up to date and did not need pushing.
320 For a successfully pushed ref, the summary shows the old and new
321 values of the ref in a form suitable for using as an argument to
322 `git log` (this is `<old>..<new>` in most cases, and
323 `<old>...<new>` for forced non-fast-forward updates).
325 For a failed update, more details are given:
329 Git did not try to send the ref at all, typically because it
330 is not a fast-forward and you did not force the update.
333 The remote end refused the update. Usually caused by a hook
334 on the remote side, or because the remote repository has one
335 of the following safety options in effect:
336 `receive.denyCurrentBranch` (for pushes to the checked out
337 branch), `receive.denyNonFastForwards` (for forced
338 non-fast-forward updates), `receive.denyDeletes` or
339 `receive.denyDeleteCurrent`. See linkgit:git-config[1].
342 The remote end did not report the successful update of the ref,
343 perhaps because of a temporary error on the remote side, a
344 break in the network connection, or other transient error.
348 The name of the local ref being pushed, minus its
349 `refs/<type>/` prefix. In the case of deletion, the
350 name of the local ref is omitted.
353 The name of the remote ref being updated, minus its
354 `refs/<type>/` prefix.
357 A human-readable explanation. In the case of successfully pushed
358 refs, no explanation is needed. For a failed ref, the reason for
359 failure is described.
361 Note about fast-forwards
362 ------------------------
364 When an update changes a branch (or more in general, a ref) that used to
365 point at commit A to point at another commit B, it is called a
366 fast-forward update if and only if B is a descendant of A.
368 In a fast-forward update from A to B, the set of commits that the original
369 commit A built on top of is a subset of the commits the new commit B
370 builds on top of. Hence, it does not lose any history.
372 In contrast, a non-fast-forward update will lose history. For example,
373 suppose you and somebody else started at the same commit X, and you built
374 a history leading to commit B while the other person built a history
375 leading to commit A. The history looks like this:
385 Further suppose that the other person already pushed changes leading to A
386 back to the original repository from which you two obtained the original
389 The push done by the other person updated the branch that used to point at
390 commit X to point at commit A. It is a fast-forward.
392 But if you try to push, you will attempt to update the branch (that
393 now points at A) with commit B. This does _not_ fast-forward. If you did
394 so, the changes introduced by commit A will be lost, because everybody
395 will now start building on top of B.
397 The command by default does not allow an update that is not a fast-forward
398 to prevent such loss of history.
400 If you do not want to lose your work (history from X to B) or the work by
401 the other person (history from X to A), you would need to first fetch the
402 history from the repository, create a history that contains changes done
403 by both parties, and push the result back.
405 You can perform "git pull", resolve potential conflicts, and "git push"
406 the result. A "git pull" will create a merge commit C between commits A
417 Updating A with the resulting merge commit will fast-forward and your
418 push will be accepted.
420 Alternatively, you can rebase your change between X and B on top of A,
421 with "git pull --rebase", and push the result back. The rebase will
422 create a new commit D that builds the change between X and B on top of
433 Again, updating A with this commit will fast-forward and your push will be
436 There is another common situation where you may encounter non-fast-forward
437 rejection when you try to push, and it is possible even when you are
438 pushing into a repository nobody else pushes into. After you push commit
439 A yourself (in the first picture in this section), replace it with "git
440 commit --amend" to produce commit B, and you try to push it out, because
441 forgot that you have pushed A out already. In such a case, and only if
442 you are certain that nobody in the meantime fetched your earlier commit A
443 (and started building on top of it), you can run "git push --force" to
444 overwrite it. In other words, "git push --force" is a method reserved for
445 a case where you do mean to lose history.
452 Works like `git push <remote>`, where <remote> is the
453 current branch's remote (or `origin`, if no remote is
454 configured for the current branch).
457 Without additional configuration, pushes the current branch to
458 the configured upstream (`remote.origin.merge` configuration
459 variable) if it has the same name as the current branch, and
460 errors out without pushing otherwise.
462 The default behavior of this command when no <refspec> is given can be
463 configured by setting the `push` option of the remote, or the `push.default`
464 configuration variable.
466 For example, to default to pushing only the current branch to `origin`
467 use `git config remote.origin.push HEAD`. Any valid <refspec> (like
468 the ones in the examples below) can be configured as the default for
471 `git push origin :`::
472 Push "matching" branches to `origin`. See
473 <refspec> in the <<OPTIONS,OPTIONS>> section above for a
474 description of "matching" branches.
476 `git push origin master`::
477 Find a ref that matches `master` in the source repository
478 (most likely, it would find `refs/heads/master`), and update
479 the same ref (e.g. `refs/heads/master`) in `origin` repository
480 with it. If `master` did not exist remotely, it would be
483 `git push origin HEAD`::
484 A handy way to push the current branch to the same name on the
487 `git push mothership master:satellite/master dev:satellite/dev`::
488 Use the source ref that matches `master` (e.g. `refs/heads/master`)
489 to update the ref that matches `satellite/master` (most probably
490 `refs/remotes/satellite/master`) in the `mothership` repository;
491 do the same for `dev` and `satellite/dev`.
493 This is to emulate `git fetch` run on the `mothership` using `git
494 push` that is run in the opposite direction in order to integrate
495 the work done on `satellite`, and is often necessary when you can
496 only make connection in one way (i.e. satellite can ssh into
497 mothership but mothership cannot initiate connection to satellite
498 because the latter is behind a firewall or does not run sshd).
500 After running this `git push` on the `satellite` machine, you would
501 ssh into the `mothership` and run `git merge` there to complete the
502 emulation of `git pull` that were run on `mothership` to pull changes
505 `git push origin HEAD:master`::
506 Push the current branch to the remote ref matching `master` in the
507 `origin` repository. This form is convenient to push the current
508 branch without thinking about its local name.
510 `git push origin master:refs/heads/experimental`::
511 Create the branch `experimental` in the `origin` repository
512 by copying the current `master` branch. This form is only
513 needed to create a new branch or tag in the remote repository when
514 the local name and the remote name are different; otherwise,
515 the ref name on its own will work.
517 `git push origin :experimental`::
518 Find a ref that matches `experimental` in the `origin` repository
519 (e.g. `refs/heads/experimental`), and delete it.
521 `git push origin +dev:master`::
522 Update the origin repository's master branch with the dev branch,
523 allowing non-fast-forward updates. *This can leave unreferenced
524 commits dangling in the origin repository.* Consider the
525 following situation, where a fast-forward is not possible:
528 o---o---o---A---B origin/master
533 The above command would change the origin repository to
536 A---B (unnamed branch)
538 o---o---o---X---Y---Z master
541 Commits A and B would no longer belong to a branch with a symbolic name,
542 and so would be unreachable. As such, these commits would be removed by
543 a `git gc` command on the origin repository.
547 Part of the linkgit:git[1] suite