GIT-PUSH(1)

โœจ GIT-PUSH(1) โœจ

okay bestie, this is straight out of the Git Manual โ€” GIT-PUSH(1) โ€” and it's genuinely one of the most main-character commands in all of git. Let's get into it ๐Ÿ’…


๐ŸŒˆ NAME ๐ŸŒˆ

git-push โ€” update remote refs along with associated objects โœจ


๐ŸŽ€ SYNOPSIS ๐ŸŽ€

         [--repo=<repository>] [-f | --force] [-d | --delete] [--prune] [-q | --quiet] [-v | --verbose]
         [-u | --set-upstream] [-o <string> | --push-option=<string>]
         [--[no-]signed | --signed=(true|false|if-asked)]
         [--force-with-lease[=<refname>[:<expect>]] [--force-if-includes]]
         [--no-verify] [<repository> [<refspec>...]]

๐Ÿ’– DESCRIPTION ๐Ÿ’–

So what does it do? It updates one or more branches, tags, or other references in one or more remote repositories from your local repository, and it sends all the necessary data that isn't already on the remote. Basically: "here's my stuff, take it" ๐Ÿซถ

The simplest way to push is git push <remote> <branch>. Like, git push origin main will push the local main branch to the main branch on the remote named origin. iconic, no notes.

You can also push to multiple remotes at once by using a remote group โœจ A remote group is a named list of remotes configured via remotes.<name> in your git config:

$ git config remotes.all-remotes "origin gitlab backup"

Then git push all-remotes will push to origin, gitlab, and backup in turn, as if you had run git push against each one individually. Each remote is pushed independently using its own push mapping configuration. There's a remotes.<group> entry in the configuration file. (See git-config(1).)

The <repository> argument defaults to the upstream for the current branch, or origin if there's no configured upstream. thoughtful queen behavior ๐Ÿ’–

To decide which branches, tags, or other refs to push, Git uses (in order of precedence):

  1. The <refspec> argument(s) (for example main in git push origin main) or the --all, --mirror, or --tags options
  2. The remote.<name>.push configuration for the repository being pushed to
  3. The push.default configuration. The default is push.default=simple, which will push to a branch with the same name as the current branch. See the CONFIGURATION section below for more on push.default.
heads up bestie ๐Ÿšจ git push may fail if you haven't set an upstream for the current branch, depending on what push.default is set to. See the UPSTREAM BRANCHES section below for more on how to set and use upstreams.

And you can make interesting things happen to a repository every time you push into it, by setting up hooks there. See documentation for git-receive-pack(1). the way that's lowkey magical ๐Ÿ˜ญ


๐Ÿ’… OPTIONS ๐Ÿ’…

  • <repository> โ€” the "remote" repository that is the destination of a push operation. This parameter can be either a URL (see the section GIT URLS below), the name of a remote (see the section REMOTES below), or the name of a remote group (see the section REMOTE GROUPS below) ๐Ÿฆ‹
  • <refspec>... โ€” specify what destination ref to update with what source object.

The format for a refspec is [+]<src>[:<dst>], for example main, main:other, or HEAD^:refs/heads/main.

The <src> is often the name of the local branch to push, but it can be any arbitrary "SHA-1 expression" (see gitrevisions(7)). โœจ

The <dst> determines what ref to update on the remote side. It must be the name of a branch, tag, or other ref, not an arbitrary expression. no funny business ๐Ÿ’€

The + is optional and does the same thing as --force.

You can write a refspec using the fully expanded form (for example refs/heads/main:refs/heads/main) which specifies the exact source and destination, or with a shorter form (for example main or main:other). Here are the rules for how refspecs are expanded, as well as various other special refspec forms:

  • <src> without a :<dst> means to update the same ref as the <src>, unless the remote.<repository>.push configuration specifies a different <dst>. For example, if main is a branch, then the refspec main expands to main:refs/heads/main.
  • If <dst> unambiguously refers to a ref on the <repository> remote, then expand it to that ref. For example, if v1.0 is a tag on the remote, then HEAD:v1.0 expands to HEAD:refs/tags/v1.0.
  • If <src> resolves to a ref starting with refs/heads/ or refs/tags/, then prepend that to <dst>. For example, if main is a branch, then main:other expands to main:refs/heads/other
  • The special refspec : (or +: to allow non-fast-forward updates) directs Git to push "matching" branches: for every branch that exists on the local side, the remote side is updated if a branch of the same name already exists on the remote side.
  • <src> may contain a * to indicate a simple pattern match. This works like a glob that matches any ref matching the pattern. There must be only one * in both the <src> and <dst>. It will map refs to the destination by replacing the * with the contents matched from the source. For example, refs/heads/*:refs/heads/* will push all branches.
  • A refspec starting with ^ is a negative refspec. This specifies refs to exclude. A ref will be considered to match if it matches at least one positive refspec, and does not match any negative refspec. Negative refspecs can be pattern refspecs. They must only contain a <src>. Fully spelled out hex object names are also not supported. For example, git push origin 'refs/heads/*' '^refs/heads/dev-*' will push all branches except for those starting with dev-
  • If <src> is empty, it deletes the <dst> ref from the remote repository. For example, git push origin :dev will delete the dev branch.
  • tag <tag> expands to refs/tags/<tag>:refs/tags/<tag>. This is technically a special syntax for git push and not a refspec, since in git push origin tag v1.0 the arguments tag and v1.0 are separate.
  • If the refspec can't be expanded unambiguously, error out with an error indicating what was tried, and depending on the advice.pushUnqualifiedRefname configuration (see git-config(1)) suggest what refs/ namespace you may have wanted to push to.
not all updates are allowed: see PUSH RULES below for the details ๐Ÿ‘€
  • --all, --branches โ€” push all branches (i.e. refs under refs/heads/); cannot be used with other <refspec>. all of them, bestie ๐Ÿ’œ
  • --prune โ€” remove remote branches that don't have a local counterpart. For example a remote branch tmp will be removed if a local branch with the same name doesn't exist any more. This also respects refspecs, e.g. git push --prune remote refs/heads/*:refs/tmp/* would make sure that remote refs/tmp/foo will be removed if refs/heads/foo doesn't exist. cleaning up your room core ๐Ÿงนโœจ
  • --mirror โ€” instead of naming each ref to push, specifies that all refs under refs/ (which includes but is not limited to refs/heads/, refs/remotes/, and refs/tags/) be mirrored to the remote repository. Newly created local refs will be pushed to the remote end, locally updated refs will be force updated on the remote end, and deleted refs will be removed from the remote end. This is the default if the configuration option remote.<remote>.mirror is set. ๐Ÿ‘‘
  • -n, --dry-run โ€” do everything except actually send the updates. dress rehearsal vibes ๐ŸŽญ
  • --porcelain โ€” produce machine-readable output. The output status line for each ref will be tab-separated and sent to stdout instead of stderr. The full symbolic names of the refs will be given. for the robots ๐Ÿค–
  • -d, --delete โ€” all listed refs are deleted from the remote repository. This is the same as prefixing all refs with a colon.
  • --tags โ€” all refs under refs/tags are pushed, in addition to refspecs explicitly listed on the command line. ๐Ÿท๏ธ
  • --follow-tags โ€” push all the refs that would be pushed without this option, and also push annotated tags in refs/tags that are missing from the remote but are pointing at commit-ish that are reachable from the refs being pushed. This can also be specified with configuration variable push.followTags. For more information, see push.followTags in git-config(1).
  • --signed, --no-signed, --signed=(true|false|if-asked) โ€” GPG-sign the push request to update refs on the receiving side, to allow it to be checked by the hooks and/or be logged. Possible values are:
    • false, --no-signed โ€” no signing will be attempted.
    • true, --signed โ€” the push will fail if the server does not support signed pushes.
    • if-asked โ€” sign if and only if the server supports signed pushes. The push will also fail if the actual call to gpg --sign fails. See git-receive-pack(1) for the details on the receiving end.
  • --atomic, --no-atomic โ€” use an atomic transaction on the remote side if available. Either all refs are updated, or on error, no refs are updated. If the server does not support atomic pushes the push will fail. all or nothing, periodt ๐Ÿ’…
  • -o <option>, --push-option=<option> โ€” transmit the given string to the server, which passes them to the pre-receive as well as the post-receive hook. The given string must not contain a NUL or LF character. When multiple --push-option=<option> are given, they are all sent to the other side in the order listed on the command line. When no --push-option=<option> is given from the command line, the values of configuration variable push.pushOption are used instead.
  • --receive-pack=<git-receive-pack>, --exec=<git-receive-pack> โ€” path to the git-receive-pack program on the remote end. Sometimes useful when pushing to a remote repository over ssh, and you do not have the program in a directory on the default $PATH. ๐Ÿ›ฐ๏ธ
  • --force-with-lease, --no-force-with-lease, --force-with-lease=<refname>, --force-with-lease=<refname>:<expect> โ€” usually, git push refuses to update a remote ref that is not an ancestor of the local ref used to overwrite it.

This option overrides this restriction if the current value of the remote ref is the expected value. git push fails otherwise.

Imagine that you have to rebase what you have already published. You will have to bypass the "must fast-forward" rule in order to replace the history you originally published with the rebased history. If somebody else built on top of your original history while you are rebasing, the tip of the branch at the remote may advance with their commit, and blindly pushing with --force will lose their work. ๐Ÿ˜ญ please don't lose their work bestie

So like, this option is you telling git "bestie, the history I'm updating is exactly what I rebased, and I want to replace it, mwah." If the remote ref still points at the commit you specified, you can be sure nobody else touched that ref. It's literally taking a "lease" on the ref without locking it, and the remote ref gets updated only if that "lease" is still valid. ๐ŸŽ€

  • --force-with-lease all on its own, no details given, protects all remote refs that are gonna be updated, by requiring their current value to be the same as the remote-tracking branch we have for them.
  • --force-with-lease=<refname>, with no expected value, protects <refname> (alone), if it's gonna be updated, by requiring its current value to be the same as the remote-tracking branch we have for it.
  • --force-with-lease=<refname>:<expect> protects <refname> (alone), if it's gonna be updated, by requiring its current value to be the same as the specified value <expect>. And <expect> is allowed to be different from the remote-tracking branch we have for the refname โ€” or we don't even have to have such a remote-tracking branch when this form is used. Also: if <expect> is the empty string, then the named ref must not already exist. โœจ
Heads up bestie โ€” every form other than --force-with-lease=<refname>:<expect> (the one that specifies the expected current value of the ref explicitly) is still experimental, and the semantics may change as we gain experience with this feature. ๐Ÿ™ˆ

And --no-force-with-lease cancels out all the previous --force-with-lease on the command line. Slay, undoing your own lease. ๐Ÿ’…


๐Ÿšจ a general note on safety (read this, fr)

Supplying this option without an expected value โ€” i.e. as --force-with-lease or --force-with-lease=<refname> โ€” interacts very badly with anything that implicitly runs git fetch on the remote you're pushing to, in the background. Like, for example, git fetch origin running on your repository in a cronjob. ๐Ÿ˜ญ

The protection it offers over --force is ensuring that subsequent changes your work wasn't based on aren't clobbered โ€” but that is trivially defeated if some background process is updating refs in the background. We don't have anything except the remote tracking info to go by as a heuristic for refs you're expected to have seen & are willing to clobber. That's it, that's the whole vibe check.

If your editor or some other system is running git fetch in the background for you, one way to mitigate this is to simply set up another remote:

git remote add origin-push $(git config remote.origin.url)
git fetch origin-push

Now when the background process runs git fetch origin, the references on origin-push won't be updated, and thus commands like:

git push --force-with-lease origin-push

will fail unless you manually run git fetch origin-push. This method is of course entirely defeated by something that runs git fetch --all ๐Ÿ˜ฉ โ€” in that case you'd need to either disable it or do something more tedious like:

git fetch              # update 'master' from remote
git tag base master    # mark our base point
git rebase -i master   # rewrite some commits
git push --force-with-lease=master:base master:master

I.e. create a base tag for versions of the upstream code that you've seen and are willing to overwrite ๐Ÿซถ, then rewrite history, and finally force push changes to master if the remote version is still at base โ€” regardless of what your local remotes/origin/master has been updated to in the background. Iconic workaround tbh.

Alternatively, specifying --force-if-includes as an ancillary option along with --force-with-lease[=<refname>] โ€” like, without saying what exact commit the ref on the remote side must be pointing at, or which refs on the remote side are being protected โ€” at the time of "push" will verify if updates from the remote-tracking refs that may have been implicitly updated in the background are integrated locally before allowing a forced update. ๐Ÿฆ‹


  • -f, --force โ€” Usually, git push will refuse to update a branch that is not an ancestor of the commit being pushed. This flag disables that check, plus the other safety checks in PUSH RULES below, plus the checks in --force-with-lease. It can cause the remote repository to lose commits โ€” use it with care, bestie. ๐Ÿ’€

Note that --force applies to all the refs that are pushed, hence using it with push.default set to matching or with multiple push destinations configured with remote.<name>.push may overwrite refs other than the current branch (including local refs that are strictly behind their remote counterpart). To force a push to only one branch, use a + in front of the refspec to push (e.g git push origin +master to force a push to the master branch). See the <refspec>... section above for details. ๐Ÿ“

  • --force-if-includes, --no-force-if-includes โ€” Force an update only if the tip of the remote-tracking ref has been integrated locally. ๐Ÿ”ฅ

This option enables a check that verifies if the tip of the remote-tracking ref is reachable from one of the "reflog" entries of the local branch based in it for a rewrite. The check ensures that any updates from the remote have been incorporated locally, by rejecting the forced update if that is not the case. Highkey useful.

If the option is passed without specifying --force-with-lease, or specified along with --force-with-lease=<refname>:<expect>, it is a "no-op" โ€” like, it literally does nothing. ๐Ÿ™ˆ

Specifying --no-force-if-includes disables this behavior.

  • --repo=<repository> โ€” This option is equivalent to the <repository> argument. If both are specified, the command-line argument takes precedence. (Command line stays main character. ๐Ÿ‘‘)
  • -u, --set-upstream โ€” For every branch that is up to date or successfully pushed, add upstream (tracking) reference, used by argument-less git-pull(1) and other commands. For more information, see branch.<name>.merge in git-config(1). ๐Ÿงš
  • --thin, --no-thin โ€” These options are passed to git-send-pack(1). A thin transfer significantly reduces the amount of sent data when the sender and receiver share many of the same objects in common. The default is --thin. ๐Ÿ’–
  • -q, --quiet โ€” Suppress all output, including the listing of updated refs, unless an error occurs. Progress is not reported to the standard error stream. Silence is golden, periodt.
  • -v, --verbose โ€” Run verbosely. (Yes that's the whole description, and honestly? It ate. ๐Ÿ’…)
  • --progress โ€” Progress status is reported on the standard error stream by default when it is attached to a terminal, unless -q is specified. This flag forces progress status even if the standard error stream is not directed to a terminal. Give me the little moving bars even when nobody's watching. ๐ŸŽ€
  • --no-recurse-submodules, --recurse-submodules=(check|on-demand|only|no) โ€” May be used to make sure all submodule commits used by the revisions to be pushed are available on a remote-tracking branch. Possible values are:
    • check โ€” Git will verify that all submodule commits that changed in the revisions to be pushed are available on at least one remote of the submodule. If any commits are missing the push will be aborted and exit with non-zero status. ๐Ÿ˜ค
    • on-demand โ€” all submodules that changed in the revisions to be pushed will be pushed. If on-demand was not able to push all necessary revisions it will also be aborted and exit with non-zero status.
    • only โ€” all submodules will be pushed while the superproject is left unpushed. Superproject said "not my era." ๐Ÿฆ‹
    • no โ€” override the push.recurseSubmodules configuration variable when no submodule recursion is required. Similar to using --no-recurse-submodules.

When using on-demand or only, if a submodule has a push.recurseSubmodules=(on-demand|only) or submodule.recurse configuration, further recursion will occur. In this case, only is treated as on-demand. ๐ŸŒธ

  • --verify, --no-verify โ€” Toggle the pre-push hook (see githooks(5)). The default is --verify, giving the hook a chance to prevent the push. With --no-verify, the hook is bypassed completely. Bestie is sneaking past the bouncer. ๐Ÿ™ˆ
  • -4, --ipv4 โ€” Use IPv4 addresses only, ignoring IPv6 addresses.
  • -6, --ipv6 โ€” Use IPv6 addresses only, ignoring IPv4 addresses. ๐ŸŒˆ

๐ŸŒ GIT URLS ๐ŸŒ

ok so bestie, a URL is literally the whole vibe-check of where your repo lives ๐Ÿ’… in general, URLs carry three things: the info about the transport protocol, the address of the remote server, and the path to the repository. and depending on the transport protocol, some of that info might just... not be there. it's giving "optional participation" โœจ

Git supports ssh, git, http, and https protocols. (also, ftp and ftps can be used for fetching, but that's inefficient and deprecated โ€” do not use them. like, seriously, don't ๐Ÿ˜ญ)

the native transport (i.e. the git:// URL) does no authentication and should be used with caution on unsecured networks. no cap, be careful with that one ๐Ÿšจ

The following syntaxes may be used with them:

  • ssh://[<user>@]<host>[:<port>]/<path-to-git-repo>
  • git://<host>[:<port>]/<path-to-git-repo>
  • http[s]://<host>[:<port>]/<path-to-git-repo>
  • ftp[s]://<host>[:<port>]/<path-to-git-repo>

An alternative scp-like syntax may also be used with the ssh protocol:

  • [<user>@]<host>:/<path-to-git-repo>

This syntax is only recognized if there are no slashes before the first colon. that little detail is what helps differentiate a local path that contains a colon ๐ŸŽ€ for example, the local path foo:bar could be specified as an absolute path or ./foo:bar to avoid being misinterpreted as an ssh url. periodt.

The ssh and git protocols additionally support ~<username> expansion:

  • ssh://[<user>@]<host>[:<port>]/~<user>/<path-to-git-repo>
  • git://<host>[:<port>]/~<user>/<path-to-git-repo>
  • [<user>@]<host>:~<user>/<path-to-git-repo>

For local repositories โ€” also supported by Git natively, iconic behaviour โ€” the following syntaxes may be used:

  • /path/to/repo.git/
  • file:///path/to/repo.git/

These two syntaxes are mostly equivalent, except when cloning, when the former implies the --local option. see git-clone(1) for details ๐Ÿ‘‘

git clone, git fetch and git pull, but not git push, will also accept a suitable bundle file. see git-bundle(1) ๐Ÿ’–

When Git doesn't know how to handle a certain transport protocol, it attempts to use the remote-<transport> remote helper, if one exists. to explicitly request a remote helper, the following syntax may be used:

  • <transport>::<address>

where <address> may be a path, a server and path, or an arbitrary URL-like string recognized by the specific remote helper being invoked. see gitremote-helpers(7) for details ๐Ÿฆ‹

If there are a large number of similarly-named remote repositories and you want to use a different format for them (such that the URLs you use will be rewritten into URLs that work), you can create a configuration section of the form:

[url "<actual-url-base>"]
        insteadOf = <other-url-base>

For example, with this:

[url "git://git.host.xz/"]
        insteadOf = host.xz:/path/to/
        insteadOf = work:

a URL like "work:repo.git" or like "host.xz:/path/to/repo.git" will be rewritten in any context that takes a URL to be "git://git.host.xz/repo.git" โœจ

If you want to rewrite URLs for push only, you can create a configuration section of the form:

[url "<actual-url-base>"]
        pushInsteadOf = <other-url-base>

For example, with this:

[url "ssh://example.org/"]
        pushInsteadOf = git://example.org/

a URL like "git://example.org/path/to/repo.git" will be rewritten to "ssh://example.org/path/to/repo.git" for pushes, but pulls will still use the original URL. the way that works is honestly so satisfying ๐Ÿ’…


๐Ÿ“ REMOTES ๐Ÿ“

The name of one of the following can be used instead of a URL as the <repository> argument:

  • a remote in the Git configuration file: $GIT_DIR/config,
  • a file in the $GIT_DIR/remotes directory, or
  • a file in the $GIT_DIR/branches directory.

all of these also allow you to omit the refspec from the command line, because they each contain a refspec which git will use by default. convenient or what ๐ŸŽ€

๐Ÿ—‚๏ธ Named remote in configuration file

You can choose to provide the name of a remote which you had previously configured using git-remote(1), git-config(1) or even by a manual edit to the $GIT_DIR/config file. The URL of this remote will be used to access the repository. The refspec of this remote will be used by default when you do not provide a refspec on the command line. the entry in the config file would appear like this:

[remote "<name>"]
        url = <URL>
        pushurl = <pushurl>
        push = <refspec>
        fetch = <refspec>

The <pushurl> is used for pushes only. it's optional and defaults to <URL>. pushing to a remote affects all defined pushurls or all defined urls if no pushurls are defined. Fetch, however, will only fetch from the first defined url if multiple urls are defined. yeah, asymmetry, we love her ๐Ÿ™ˆ

๐Ÿ“ Named file in $GIT_DIR/remotes

You can choose to provide the name of a file in $GIT_DIR/remotes. The URL in this file will be used to access the repository. The refspec in this file will be used as default when you do not provide a refspec on the command line. This file should have the following format:

URL: one of the above URL formats
Push: <refspec>
Pull: <refspec>

Push: lines are used by git push and Pull: lines are used by git pull and git fetch. multiple Push: and Pull: lines may be specified for additional branch mappings ๐ŸŒธ

๐ŸŒฟ Named file in $GIT_DIR/branches

You can choose to provide the name of a file in $GIT_DIR/branches. The URL in this file will be used to access the repository. This file should have the following format:

<URL>#<head>

<URL> is required; #<head> is optional.

Depending on the operation, git will use one of the following refspecs, if you don't provide one on the command line. <branch> is the name of this file in $GIT_DIR/branches and <head> defaults to master. (yes, master โ€” that's what it says, don't come for me ๐Ÿ’€)

git fetch uses:

refs/heads/<head>:refs/heads/<branch>

git push uses:

HEAD:refs/heads/<head>

โฌ†๏ธ UPSTREAM BRANCHES โฌ†๏ธ

Branches in Git can optionally have an upstream remote branch. Git defaults to using the upstream branch for remote operations, for example:

  • It's the default for git pull or git fetch with no arguments.
  • It's the default for git push with no arguments, with some exceptions. for example, you can use the branch.<name>.pushRemote option to push to a different remote than you pull from, and by default with push.default=simple the upstream branch you configure must have the same name.
  • Various commands, including git checkout and git status, will show you how many commits have been added to your current branch and the upstream since you forked from it, for example "Your branch and origin/main have diverged, and have 2 and 3 different commits each respectively" ๐Ÿ‘€ iconic little status message tbh

The upstream is stored in .git/config, in the "remote" and "merge" fields. For example, if main's upstream is origin/main:

[branch "main"]
   remote = origin
   merge = refs/heads/main

You can set an upstream branch explicitly with git push --set-upstream <remote> <branch> but Git will often automatically set the upstream for you, for example:

  • When you clone a repository, Git will automatically set the upstream for the default branch.
  • If you have the push.autoSetupRemote configuration option set, git push will automatically set the upstream the first time you push a branch.
  • Checking out a remote-tracking branch with git checkout <branch> will automatically create a local branch with that name and set the upstream to the remote branch.
Note Upstream branches are sometimes referred to as "tracking information", as in "set the branch's tracking information". iykyk ๐Ÿซถ

๐Ÿ‘ฏ REMOTE GROUPS ๐Ÿ‘ฏ

A remote group is a named list of remotes configured via remotes.<name> in your git config:

$ git config remotes.all-remotes "r1 r2 r3"

When a group name is given as the <repository> argument, the push is performed to each member remote in turn. The defining principle is:

git push <options> all-remotes <args>

is exactly equivalent to:

git push <options> r1 <args>
git push <options> r2 <args>
...
git push <options> rN <args>

where r1, r2, ..., rN are the members of all-remotes. No special behaviour is added or removed โ€” the group is purely a shorthand for running the same push command against each member remote individually. that's it, that's the whole tea โ˜•

When pushing to a group of more than one remote, Git spawns a separate git push subprocess for each member remote in sequence. Each subprocess receives the same flags and refspecs as the original invocation. This means that per-remote push mappings configured via remote.<name>.push and mirror mode (remote.<name>.mirror) are evaluated independently for each remote, and a mirror remote in the group cannot affect the push behaviour of other non-mirror remotes in the same group. so no sneaky cross-contamination ๐Ÿ’…

The --atomic option is not supported for group pushes, because atomicity can only be guaranteed within a single transport connection to a single remote. Git will refuse the invocation with an error if --atomic is combined with a group name. like, straight up nope ๐Ÿšซ

If any member remote fails โ€” whether due to a push rejection (e.g. a non-fast-forward update, a server-side hook refusing a ref) or a connection error (e.g. the repository does not exist, authentication fails, or the network is unreachable) โ€” Git reports the error and continues pushing to the remaining remotes in the group. The overall exit code is non-zero if any member push fails. so you get all the receipts at the end ๐Ÿ“‹

This means the user is responsible for ensuring that the sequence of individual pushes makes sense. If git push r1 would fail for a given set of options and arguments, then git push all-remotes will fail in the same way when it reaches r1. The group push does not do anything special to make a failing individual push succeed. it's a shorthand, not a miracle worker ๐Ÿ˜ญโœจ

๐Ÿ’… OUTPUT ๐Ÿ’…

okay so the output of git push is literally not one-size-fits-all bestie โ€” it depends on the transport method you used. this section is describing the output when you push over the Git protocol (either locally or via ssh). slay.

The status of the push comes out in tabular form, with each line representing the status of a single ref. Every line looks like this:

<flag> <summary> <from> -> <to> (<reason>)

If you use --porcelain, then each line of the output is in this format instead:

<flag> \t <from>:<to> \t <summary> (<reason>)

โœจ little detail: the status of up-to-date refs is only shown if the --porcelain or --verbose option is used. otherwise they're just quietly living their lives, no cap.

๐ŸŒธ <flag> ๐ŸŒธ

A single character indicating the status of the ref, and honestly each one is giving its own whole personality:

  • (<space>) โ€” for a successfully pushed fast-forward ๐Ÿซถ
  • + โ€” for a successful forced update ๐Ÿ’ช
  • - โ€” for a successfully deleted ref ๐Ÿ—‘๏ธ
  • * โ€” for a successfully pushed new ref โญ
  • ! โ€” for a ref that was rejected or failed to push ๐Ÿ˜ญ
  • = โ€” for a ref that was up to date and did not need pushing ๐Ÿ˜ด

๐ŸŽ€ <summary> ๐ŸŽ€

For a successfully pushed ref, the summary shows the old and new values of the ref in a form suitable for using as an argument to git log โ€” this is <old>..<new> in most cases, and <old>...<new> for forced non-fast-forward updates. iykyk.

For a failed update, more details are given, and it's giving diagnosis energy:

  • rejected โ€” Git did not try to send the ref at all, typically because it is not a fast-forward and you did not force the update. it simply said no ๐Ÿ’€
  • remote rejected โ€” The remote end refused the update. Usually caused by a hook on the remote side, or because the remote repository has one of the following safety options in effect: receive.denyCurrentBranch (for pushes to the checked out branch), receive.denyNonFastForwards (for forced non-fast-forward updates), receive.denyDeletes or receive.denyDeleteCurrent. See git-config(1). the remote is simply built different (protective).
  • remote failure โ€” The remote end did not report the successful update of the ref, perhaps because of a temporary error on the remote side, a break in the network connection, or other transient error. it's not you, it's the network ๐Ÿ™ˆ

๐Ÿ’œ from ๐Ÿ’œ

The name of the local ref being pushed, minus its refs/<type>/ prefix. In the case of deletion, the name of the local ref is omitted. (nothing to show when it's gone, bestie ๐Ÿฆ‹)

๐ŸŒˆ to ๐ŸŒˆ

The name of the remote ref being updated, minus its refs/<type>/ prefix.

๐Ÿ“ reason ๐Ÿ“

A human-readable explanation. In the case of successfully pushed refs, no explanation is needed (it slayed, what more do you want). For a failed ref, the reason for failure is described.


๐ŸŒธ PUSH RULES ๐ŸŒธ

okay so as a safety feature, the git push command only allows certain kinds of updates โ€” that's literally the whole point, it's there to prevent you from accidentally losing data on the remote. it's the seatbelt of git, fr fr.

Because branches and tags are intended to be used differently, the safety rules for pushing to a branch are different from the rules for pushing to a tag. And in the following rules, "update" means any modifications except deletions and creations. Deletions and creations are always allowed, except when forbidden by configuration or hooks. periodt.

  1. If the push destination is a branch (refs/heads/*): only fast-forward updates are allowed, which means the destination must be an ancestor of the source commit. The source must be a commit.
  2. If the push destination is a tag (refs/tags/*): all updates will be rejected. The source can be any object. (tags are simply not taking updates, no notes ๐Ÿ’…)
  3. If the push destination is not a branch or tag:
    • If the source is a tree or blob object, any updates will be rejected
    • If the source is a tag or commit object, any fast-forward update is allowed, even in cases where what's being fast-forwarded is not a commit, but a tag object which happens to point to a new commit which is a fast-forward of the commit the last tag (or commit) it's replacing. Replacing a tag with an entirely different tag is also allowed, if it points to the same commit, as well as pushing a peeled tag, i.e. pushing the commit that existing tag object points to, or a new tag object which an existing commit points to. (yes this whole bullet ate, i know ๐Ÿงš)

You can override these rules by passing --force or by adding the optional leading + to a refspec. The only exceptions are that:

  • no amount of forcing will make a branch accept a non-commit object
  • forcing won't make the remote repository accept a push that it's configured to deny
bestie please internalize that second exception ๐Ÿ˜ญ --force is not a magic wand that overrides the remote's boundaries. it's a tool, not a cheat code.

Hooks and configuration can also override or amend these rules โ€” see e.g. receive.denyNonFastForwards and receive.denyDeletes in git-config(1) and pre-receive and update in githooks(5).


โญ NOTE ABOUT FAST-FORWARDS โญ

When an update changes a branch (or more in general, a ref) that used to point at commit A to point at another commit B, it is called a fast-forward update if and only if B is a descendant of A. it's literally in the name โ€” the pointer just slides forward ๐Ÿ”ฅ

In a fast-forward update from A to B, the set of commits that the original commit A built on top of is a subset of the commits the new commit B builds on top of. Hence, it does not lose any history. nothing gets dropped, everything is preserved, we love to see it ๐Ÿซถ

In contrast, a non-fast-forward update will lose history. for example โ€” suppose you and somebody else started at the same commit X, and you built a history leading to commit B while the other person built a history leading to commit A. The history looks like this:

          B
         /
     ---X---A

Further suppose that the other person already pushed changes leading to A back to the original repository from which you two obtained the original commit X.

The push done by the other person updated the branch that used to point at commit X to point at commit A. It is a fast-forward. โœ…

But if you try to push, you will attempt to update the branch (that now points at A) with commit B. This does not fast-forward. If you did so, the changes introduced by commit A will be lost, because everybody will now start building on top of B. ๐Ÿ’€ that's the data loss scenario, and it's exactly why this page exists.

The command by default does not allow an update that is not a fast-forward, to prevent such loss of history. it's protecting you, bestie.

If you do not want to lose your work (history from X to B) or the work by the other person (history from X to A), you would need to first fetch the history from the repository, create a history that contains changes done by both parties, and push the result back. team effort fr fr.

You can perform git pull, resolve potential conflicts, and git push the result. A git pull will create a merge commit C between commits A and B.

          B---C
         /   /
     ---X---A

Updating A with the resulting merge commit will fast-forward and your push will be accepted. we love a happy ending ๐ŸŽ€

Alternatively, you can rebase your change between X and B on top of A, with git pull --rebase, and push the result back. The rebase will create a new commit D that builds the change between X and B on top of A.

          B   D
         /   /
     ---X---A

Again, updating A with this commit will fast-forward and your push will be accepted. see? iconic behavior โœจ

There is another common situation where you may encounter non-fast-forward rejection when you try to push, and it is possible even when you are pushing into a repository nobody else pushes into. yes, you can get rejected by a repo all by yourself, it's giving main character energy ๐Ÿ˜ญ

After you push commit A yourself (in the first picture in this section), replace it with git commit --amend to produce commit B, and you try to push it out, because you forgot that you have pushed A out already. In such a case, and only if you are certain that nobody in the meantime fetched your earlier commit A (and started building on top of it), you can run git push --force to overwrite it. In other words, git push --force is a method reserved for a case where you do mean to lose history.

๐Ÿซถ seriously though โ€” that "only if you are certain" is doing a lot of heavy lifting. read it again. then read it once more. ๐Ÿ”ฅ๐Ÿ™ˆ

โœจ EXAMPLES โœจ

Okay so these are the little real-life scenarios where git push gets to shine. Each one is a different flavor of sending your commits somewhere. ๐Ÿซถ

git push

Works like git push <remote>, where <remote> is the current branchโ€™s remote โ€” or origin, if no remote is configured for the current branch. Simple as that. ๐Ÿ’…

git push origin

Without extra configuration, this pushes the current branch to the configured upstream (branch.<name>.merge configuration variable) if it has the same name as the current branch. If it doesnโ€™t? It errors out without pushing. Not me getting rejected by git ๐Ÿ˜ญ.

The default behavior of this command when no <refspec> is given can be configured by setting the push option of the remote, or the push.default configuration variable.

For example, to default to pushing only the current branch to origin, use git config remote.origin.push HEAD. Any valid <refspec> โ€” like the ones in the examples below โ€” can be configured as the default for git push origin. Iconic config moment. โœจ

git push origin :

Push โ€œmatchingโ€ branches to origin. Peep <refspec> in the OPTIONS section above for the description of โ€œmatchingโ€ branches. ๐Ÿ‘‘ iykyk.

git push origin master

Find a ref that matches master in the source repository (most likely it would find refs/heads/master), and update the same ref (e.g. refs/heads/master) in the origin repository with it. If master did not exist remotely, it would be created. Boom, new branch energy. ๐ŸŒฑ Lowkey iconic.

git push origin HEAD

A handy way to push the current branch to the same name on the remote. No thinking, just vibes. ๐Ÿฆ‹ Periodt.

git push mothership master:satellite/master dev:satellite/dev

Use the source ref that matches master (e.g. refs/heads/master) to update the ref that matches satellite/master (most probably refs/remotes/satellite/master) in the mothership repository; do the same for dev and satellite/dev.

See the section describing <refspec>... above for a discussion of the matching semantics. ๐Ÿ”

This is to emulate git fetch run on the mothership using git push that is run in the opposite direction, in order to integrate the work done on satellite. Itโ€™s often necessary when you can only make connection in one way (i.e. satellite can ssh into mothership but mothership cannot initiate connection to satellite because the latter is behind a firewall or does not run sshd).

After running this git push on the satellite machine, you would ssh into the mothership and run git merge there to complete the emulation of git pull that were run on mothership to pull changes made on satellite. Full circle, bestie. ๐Ÿ”

git push origin HEAD:master

Push the current branch to the remote ref matching master in the origin repository. This form is convenient to push the current branch without thinking about its local name. Main character move: no name crisis. ๐Ÿ’…

git push origin master:refs/heads/experimental

Create the branch experimental in the origin repository by copying the current master branch. This form is only needed to create a new branch or tag in the remote repository when the local name and the remote name are different; otherwise, the ref name on its own will work. Copy-paste but make it branch. ๐ŸŽ€

git push origin :experimental

Find a ref that matches experimental in the origin repository (e.g. refs/heads/experimental), and delete it. Say bye ๐Ÿ‘‹ to that ref.

git push origin +dev:master

Update the origin repositoryโ€™s master branch with the dev branch, allowing non-fast-forward updates. This can leave unreferenced commits dangling in the origin repository. Consider the following situation, where a fast-forward is not possible:

                        o---o---o---A---B  origin/master
                                 \
                                  X---Y---Z  dev

The above command would change the origin repository to:

                                  A---B  (unnamed branch)
                                 /
                        o---o---o---X---Y---Z  master

Commits A and B would no longer belong to a branch with a symbolic name, and so would be unreachable. As such, these commits would be removed by a git gc command on the origin repository.

๐Ÿ’€ Bestie, this one allows non-fast-forward updates, and it can leave unreferenced commits dangling in origin. A git gc command on origin would remove them. Not a drill.

๐Ÿ›ก๏ธ SECURITY ๐Ÿ›ก๏ธ

Okay, serious face for a sec. ๐Ÿ˜ค The fetch and push protocols are not designed to prevent one side from stealing data from the other repository that was not intended to be shared. If you have private data that you need to protect from a malicious peer, your best option is to store it in another repository. This applies to both clients and servers. In particular, namespaces on a server are not effective for read access control; you should only grant read access to a namespace to clients that you would trust with read access to the entire repository.

The known attack vectors are as follows:

  1. The victim sends "have" lines advertising the IDs of objects it has that are not explicitly intended to be shared but can be used to optimize the transfer if the peer also has them. The attacker chooses an object ID X to steal and sends a ref to X, but isnโ€™t required to send the content of X because the victim already has it. Now the victim believes that the attacker has X, and it sends the content of X back to the attacker later. (This attack is most straightforward for a client to perform on a server, by creating a ref to X in the namespace the client has access to and then fetching it. The most likely way for a server to perform it on a client is to โ€œmergeโ€ X into a public branch and hope that the user does additional work on this branch and pushes it back to the server without noticing the merge.)
  2. As in #1, the attacker chooses an object ID X to steal. The victim sends an object Y that the attacker already has, and the attacker falsely claims to have X and not Y, so the victim sends Y as a delta against X. The delta reveals regions of X that are similar to Y to the attacker.

๐Ÿ’– push.autoSetupRemote ๐Ÿ’–

Set this bad boy to true and git will just assume --set-upstream on a default push whenever your current branch has no upstream tracking yet โ€” like it's reading your mind, lowkey. ๐Ÿง โœจ

It kicks in with the push.default options simple, upstream, and current. Super useful if you want new branches going to the default remote by default (basically the push.default=current vibe) and you want that upstream tracking set up too. The workflows that eat this up are simple central workflows where every branch is expected to have the same name on the remote. ๐Ÿ’…


๐ŸŒธ push.default ๐ŸŒธ

This one decides what git push actually does when you don't give it a refspec โ€” doesn't matter if it's missing from the command-line, the config, or wherever else. Different values are built for different workflows, so pick your fighter. For example, in a purely central workflow (like, the fetch source equals the push destination), upstream is probably your girl. ๐Ÿ’โ€โ™€๏ธ

Here's the whole roster, bestie:

  • nothing โ€” do not push anything, just error out, unless a refspec is given. This is mainly for people who want to dodge mistakes by always being explicit. No surprises, no drama. ๐Ÿ™ˆ
  • current โ€” push the current branch to update a branch with the same name on the receiving end. Works in both central and non-central workflows. Slay. โœจ
  • upstream โ€” push the current branch back to the branch whose changes usually get integrated into the current branch (that's the one called @{upstream}). This mode only makes sense if you're pushing to the same repository you'd normally pull from โ€” i.e. central workflow energy. ๐ŸŒ€
  • tracking โ€” this is a deprecated synonym for upstream. Old. Retired. Respectfully. ๐Ÿ’€
  • simple โ€” push the current branch with the same name on the remote.
    • This mode requires that the remote repository you're pushing to is known. When you're pushing back to the same remote you pull from, the current branch also has to have an upstream tracking branch with the same name.
    • This mode is the default since Git 2.0, and it's the safest option, suited for beginners. Iconic default behavior, honestly. ๐Ÿ‘‘
  • matching โ€” push all branches having the same name on both ends. This makes the repository you're pushing to remember the set of branches that will be pushed out. Like, if you always push maint and master there and no other branches, the repo you push to will have these two branches, and your local maint and master get pushed there. ๐ŸŽ€
    • To use this mode effectively, you have to make sure all the branches you'd push out are actually ready to be pushed out before running git push โ€” because the whole point of this mode is letting you push all of the branches in one go. If you usually finish work on only one branch and push that result while other branches are unfinished, this mode is not for you, sorry babe. Also, this mode is not suitable for pushing into a shared central repository, since other people may add new branches there, or update the tip of existing branches outside your control. Chaotic. ๐Ÿ˜ญ
    • This used to be the default, but not since Git 2.0 (simple is the new default). Times change, we move on. ๐Ÿฆ‹

๐ŸŽ€ push.followTags ๐ŸŽ€

Set it to true and --follow-tags becomes enabled by default. You can override this configuration at push time by specifying --no-follow-tags โ€” you're still the main character here. ๐Ÿ’…


๐Ÿฆ‹ push.gpgSign ๐Ÿฆ‹

May be set to a boolean value, or to the string if-asked.

  • A true value causes all pushes to be GPG signed, as if --signed were passed to git-push(1). ๐Ÿ”ฅ
  • The string if-asked causes pushes to be signed if the server supports it, as if --signed=if-asked were passed to git push.
  • A false value may override a value from a lower-priority config file.

And an explicit command-line flag always overrides this config option. Always. Periodt. ๐Ÿ‘‘


๐ŸŒˆ push.pushOption ๐ŸŒˆ

When no --push-option=<option> argument is given on the command line, git push behaves as if each <option> of this variable were given as --push-option=<option>.

This is a multi-valued variable, and an empty value can be used in a higher priority configuration file (like .git/config in a repository) to clear the values inherited from lower priority configuration files (like $HOME/.gitconfig). Clean slate energy. ๐Ÿงผ

Example:

/etc/gitconfig
  push.pushoption = a
  push.pushoption = b

~/.gitconfig
  push.pushoption = c

repo/.git/config
  push.pushoption =
  push.pushoption = b

This will result in only b (a and c are cleared).

๐Ÿ’œ push.recurseSubmodules ๐Ÿ’œ

May be check, on-demand, only, or no, with the same behavior as that of push --recurse-submodules.

If it's not set, no is used by default โ€” unless submodule.recurse is set, in which case a true value means on-demand. Submodules: complicated, but we handle them. ๐Ÿซถ


โญ push.useForceIfIncludes โญ

Set it to true and it's equivalent to specifying --force-if-includes as an option to git-push(1) on the command line. Adding --no-force-if-includes at the time of push overrides this configuration setting. Your push, your rules. โœจ


๐Ÿ“ push.negotiate ๐Ÿ“

Set it to true and git attempts to reduce the size of the packfile sent, by rounds of negotiation in which the client and the server try to find commits in common. If false, Git relies solely on the server's ref advertisement to find commits in common. Frugal queen behavior. ๐Ÿ‘‘


๐Ÿงš push.useBitmaps ๐Ÿงš

Set it to false and you disable the use of bitmaps for git push even if pack.useBitmaps is true โ€” and it does this without preventing other git operations from using bitmaps.

Default is true. ๐Ÿ’–


๐Ÿ‘‘ GIT ๐Ÿ‘‘

Part of the git(1) suite. One of us, one of us. ๐ŸŽ‰


That's a wrap on the whole page, bestie! You made it through all of it and I'm so proud. ๐Ÿฅน๐Ÿ’–

This gorgeous piece of documentation is Git 2.56.0, dated 2026-09-27 โ€” go forth and push responsibly, no cap. ๐Ÿฆ‹โœจ๐Ÿ’…

๐Ÿ“ฆ where this page comes from