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].
26 When the command line does not specify where to push with the
27 `<repository>` argument, `branch.*.remote` configuration for the
28 current branch is consulted to determine where to push. If the
29 configuration is missing, it defaults to 'origin'.
31 When the command line does not specify what to push with `<refspec>...`
32 arguments or `--all`, `--mirror`, `--tags` options, the command finds
33 the default `<refspec>` by consulting `remote.*.push` configuration,
34 and if it is not found, honors `push.default` configuration to decide
35 what to push (See gitlink:git-config[1] for the meaning of `push.default`).
41 The "remote" repository that is destination of a push
42 operation. This parameter can be either a URL
43 (see the section <<URLS,GIT URLS>> below) or the name
44 of a remote (see the section <<REMOTES,REMOTES>> below).
47 Specify what destination ref to update with what source object.
48 The format of a <refspec> parameter is an optional plus
49 `+`, followed by the source object <src>, followed
50 by a colon `:`, followed by the destination ref <dst>.
52 The <src> is often the name of the branch you would want to push, but
53 it can be any arbitrary "SHA-1 expression", such as `master~4` or
54 `HEAD` (see linkgit:gitrevisions[7]).
56 The <dst> tells which ref on the remote side is updated with this
57 push. Arbitrary expressions cannot be used here, an actual ref must
58 be named. If `:`<dst> is omitted, the same ref as <src> will be
61 The object referenced by <src> is used to update the <dst> reference
62 on the remote side, but by default this is only allowed if the
63 update can fast-forward <dst>. By having the optional leading `+`,
64 you can tell git to update the <dst> ref even when the update is not a
65 fast-forward. This does *not* attempt to merge <src> into <dst>. See
66 EXAMPLES below for details.
68 `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
70 Pushing an empty <src> allows you to delete the <dst> ref from
71 the remote repository.
73 The special refspec `:` (or `+:` to allow non-fast-forward updates)
74 directs git to push "matching" branches: for every branch that exists on
75 the local side, the remote side is updated if a branch of the same name
76 already exists on the remote side.
79 Instead of naming each ref to push, specifies that all
80 refs under `refs/heads/` be pushed.
83 Remove remote branches that don't have a local counterpart. For example
84 a remote branch `tmp` will be removed if a local branch with the same
85 name doesn't exist any more. This also respects refspecs, e.g.
86 `git push --prune remote refs/heads/*:refs/tmp/*` would
87 make sure that remote `refs/tmp/foo` will be removed if `refs/heads/foo`
91 Instead of naming each ref to push, specifies that all
92 refs under `refs/` (which includes but is not
93 limited to `refs/heads/`, `refs/remotes/`, and `refs/tags/`)
94 be mirrored to the remote repository. Newly created local
95 refs will be pushed to the remote end, locally updated refs
96 will be force updated on the remote end, and deleted refs
97 will be removed from the remote end. This is the default
98 if the configuration option `remote.<remote>.mirror` is
103 Do everything except actually send the updates.
106 Produce machine-readable output. The output status line for each ref
107 will be tab-separated and sent to stdout instead of stderr. The full
108 symbolic names of the refs will be given.
111 All listed refs are deleted from the remote repository. This is
112 the same as prefixing all refs with a colon.
115 All refs under `refs/tags` are pushed, in
116 addition to refspecs explicitly listed on the command
119 --receive-pack=<git-receive-pack>::
120 --exec=<git-receive-pack>::
121 Path to the 'git-receive-pack' program on the remote
122 end. Sometimes useful when pushing to a remote
123 repository over ssh, and you do not have the program in
124 a directory on the default $PATH.
128 Usually, the command refuses to update a remote ref that is
129 not an ancestor of the local ref used to overwrite it.
130 This flag disables the check. This can cause the
131 remote repository to lose commits; use it with care.
133 --repo=<repository>::
134 This option is only relevant if no <repository> argument is
135 passed in the invocation. In this case, 'git push' derives the
136 remote name from the current branch: If it tracks a remote
137 branch, then that remote repository is pushed to. Otherwise,
138 the name "origin" is used. For this latter case, this option
139 can be used to override the name "origin". In other words,
140 the difference between these two commands
142 --------------------------
144 git push --repo=public #2
145 --------------------------
147 is that #1 always pushes to "public" whereas #2 pushes to "public"
148 only if the current branch does not track a remote branch. This is
149 useful if you write an alias or script around 'git push'.
153 For every branch that is up to date or successfully pushed, add
154 upstream (tracking) reference, used by argument-less
155 linkgit:git-pull[1] and other commands. For more information,
156 see 'branch.<name>.merge' in linkgit:git-config[1].
160 These options are passed to linkgit:git-send-pack[1]. A thin transfer
161 significantly reduces the amount of sent data when the sender and
162 receiver share many of the same objects in common. The default is
167 Suppress all output, including the listing of updated refs,
168 unless an error occurs. Progress is not reported to the standard
176 Progress status is reported on the standard error stream
177 by default when it is attached to a terminal, unless -q
178 is specified. This flag forces progress status even if the
179 standard error stream is not directed to a terminal.
181 --recurse-submodules=check|on-demand::
182 Make sure all submodule commits used by the revisions to be
183 pushed are available on a remote-tracking branch. If 'check' is
184 used git will verify that all submodule commits that changed in
185 the revisions to be pushed are available on at least one remote
186 of the submodule. If any commits are missing the push will be
187 aborted and exit with non-zero status. If 'on-demand' is used
188 all submodules that changed in the revisions to be pushed will
189 be pushed. If on-demand was not able to push all necessary
190 revisions it will also be aborted and exit with non-zero status.
193 include::urls-remotes.txt[]
198 The output of "git push" depends on the transport method used; this
199 section describes the output when pushing over the git protocol (either
202 The status of the push is output in tabular form, with each line
203 representing the status of a single ref. Each line is of the form:
205 -------------------------------
206 <flag> <summary> <from> -> <to> (<reason>)
207 -------------------------------
209 If --porcelain is used, then each line of the output is of the form:
211 -------------------------------
212 <flag> \t <from>:<to> \t <summary> (<reason>)
213 -------------------------------
215 The status of up-to-date refs is shown only if --porcelain or --verbose
219 A single character indicating the status of the ref:
220 (space);; for a successfully pushed fast-forward;
221 `+`;; for a successful forced update;
222 `-`;; for a successfully deleted ref;
223 `*`;; for a successfully pushed new ref;
224 `!`;; for a ref that was rejected or failed to push; and
225 `=`;; for a ref that was up to date and did not need pushing.
228 For a successfully pushed ref, the summary shows the old and new
229 values of the ref in a form suitable for using as an argument to
230 `git log` (this is `<old>..<new>` in most cases, and
231 `<old>...<new>` for forced non-fast-forward updates).
233 For a failed update, more details are given:
237 Git did not try to send the ref at all, typically because it
238 is not a fast-forward and you did not force the update.
241 The remote end refused the update. Usually caused by a hook
242 on the remote side, or because the remote repository has one
243 of the following safety options in effect:
244 `receive.denyCurrentBranch` (for pushes to the checked out
245 branch), `receive.denyNonFastForwards` (for forced
246 non-fast-forward updates), `receive.denyDeletes` or
247 `receive.denyDeleteCurrent`. See linkgit:git-config[1].
250 The remote end did not report the successful update of the ref,
251 perhaps because of a temporary error on the remote side, a
252 break in the network connection, or other transient error.
256 The name of the local ref being pushed, minus its
257 `refs/<type>/` prefix. In the case of deletion, the
258 name of the local ref is omitted.
261 The name of the remote ref being updated, minus its
262 `refs/<type>/` prefix.
265 A human-readable explanation. In the case of successfully pushed
266 refs, no explanation is needed. For a failed ref, the reason for
267 failure is described.
269 Note about fast-forwards
270 ------------------------
272 When an update changes a branch (or more in general, a ref) that used to
273 point at commit A to point at another commit B, it is called a
274 fast-forward update if and only if B is a descendant of A.
276 In a fast-forward update from A to B, the set of commits that the original
277 commit A built on top of is a subset of the commits the new commit B
278 builds on top of. Hence, it does not lose any history.
280 In contrast, a non-fast-forward update will lose history. For example,
281 suppose you and somebody else started at the same commit X, and you built
282 a history leading to commit B while the other person built a history
283 leading to commit A. The history looks like this:
293 Further suppose that the other person already pushed changes leading to A
294 back to the original repository from which you two obtained the original
297 The push done by the other person updated the branch that used to point at
298 commit X to point at commit A. It is a fast-forward.
300 But if you try to push, you will attempt to update the branch (that
301 now points at A) with commit B. This does _not_ fast-forward. If you did
302 so, the changes introduced by commit A will be lost, because everybody
303 will now start building on top of B.
305 The command by default does not allow an update that is not a fast-forward
306 to prevent such loss of history.
308 If you do not want to lose your work (history from X to B) nor the work by
309 the other person (history from X to A), you would need to first fetch the
310 history from the repository, create a history that contains changes done
311 by both parties, and push the result back.
313 You can perform "git pull", resolve potential conflicts, and "git push"
314 the result. A "git pull" will create a merge commit C between commits A
325 Updating A with the resulting merge commit will fast-forward and your
326 push will be accepted.
328 Alternatively, you can rebase your change between X and B on top of A,
329 with "git pull --rebase", and push the result back. The rebase will
330 create a new commit D that builds the change between X and B on top of
341 Again, updating A with this commit will fast-forward and your push will be
344 There is another common situation where you may encounter non-fast-forward
345 rejection when you try to push, and it is possible even when you are
346 pushing into a repository nobody else pushes into. After you push commit
347 A yourself (in the first picture in this section), replace it with "git
348 commit --amend" to produce commit B, and you try to push it out, because
349 forgot that you have pushed A out already. In such a case, and only if
350 you are certain that nobody in the meantime fetched your earlier commit A
351 (and started building on top of it), you can run "git push --force" to
352 overwrite it. In other words, "git push --force" is a method reserved for
353 a case where you do mean to lose history.
360 Works like `git push <remote>`, where <remote> is the
361 current branch's remote (or `origin`, if no remote is
362 configured for the current branch).
365 Without additional configuration, works like
368 The default behavior of this command when no <refspec> is given can be
369 configured by setting the `push` option of the remote, or the `push.default`
370 configuration variable.
372 For example, to default to pushing only the current branch to `origin`
373 use `git config remote.origin.push HEAD`. Any valid <refspec> (like
374 the ones in the examples below) can be configured as the default for
377 `git push origin :`::
378 Push "matching" branches to `origin`. See
379 <refspec> in the <<OPTIONS,OPTIONS>> section above for a
380 description of "matching" branches.
382 `git push origin master`::
383 Find a ref that matches `master` in the source repository
384 (most likely, it would find `refs/heads/master`), and update
385 the same ref (e.g. `refs/heads/master`) in `origin` repository
386 with it. If `master` did not exist remotely, it would be
389 `git push origin HEAD`::
390 A handy way to push the current branch to the same name on the
393 `git push mothership master:satellite/master dev:satellite/dev`::
394 Use the source ref that matches `master` (e.g. `refs/heads/master`)
395 to update the ref that matches `satellite/master` (most probably
396 `refs/remotes/satellite/master`) in the `mothership` repository;
397 do the same for `dev` and `satellite/dev`.
399 This is to emulate `git fetch` run on the `mothership` using `git
400 push` that is run in the opposite direction in order to integrate
401 the work done on `satellite`, and is often necessary when you can
402 only make connection in one way (i.e. satellite can ssh into
403 mothership but mothership cannot initiate connection to satellite
404 because the latter is behind a firewall or does not run sshd).
406 After running this `git push` on the `satellite` machine, you would
407 ssh into the `mothership` and run `git merge` there to complete the
408 emulation of `git pull` that were run on `mothership` to pull changes
411 `git push origin HEAD:master`::
412 Push the current branch to the remote ref matching `master` in the
413 `origin` repository. This form is convenient to push the current
414 branch without thinking about its local name.
416 `git push origin master:refs/heads/experimental`::
417 Create the branch `experimental` in the `origin` repository
418 by copying the current `master` branch. This form is only
419 needed to create a new branch or tag in the remote repository when
420 the local name and the remote name are different; otherwise,
421 the ref name on its own will work.
423 `git push origin :experimental`::
424 Find a ref that matches `experimental` in the `origin` repository
425 (e.g. `refs/heads/experimental`), and delete it.
427 `git push origin +dev:master`::
428 Update the origin repository's master branch with the dev branch,
429 allowing non-fast-forward updates. *This can leave unreferenced
430 commits dangling in the origin repository.* Consider the
431 following situation, where a fast-forward is not possible:
434 o---o---o---A---B origin/master
439 The above command would change the origin repository to
442 A---B (unnamed branch)
444 o---o---o---X---Y---Z master
447 Commits A and B would no longer belong to a branch with a symbolic name,
448 and so would be unreachable. As such, these commits would be removed by
449 a `git gc` command on the origin repository.
453 Part of the linkgit:git[1] suite