I know how to make a new branch that tracks remote branches, but how do I make an existing branch track a remote branch?

I know I can just edit the .git/config file, but it seems there should be an easier way.

  • 20
    As noted below, for an existing branch, you can use git push -u origin branch-name. – Zags Mar 6 '14 at 23:46
  • 3
    For reference, the git branch documentation. – user456814 May 23 '14 at 18:26
  • If local branch is current branch, and local branch is not already tracking a remote, git pull will often provide helpful messages about the appropriate command to set tracking information – billrichards Aug 7 '15 at 12:59
  • 16
    It's annoying when one is learning git to be shown a link to the git documentation. That documentation appears to be written for people that already know what they are doing with git. – Felipe Alvarez Mar 18 '17 at 13:39
  • 3
    as of Git 2.10 you should first checkout to intended local branch and then do this git branch --set-upstream-to origin/<branch> – Mahdi Javaheri Sep 18 '17 at 4:59

19 Answers 19

up vote 3770 down vote accepted

Given a branch foo and a remote upstream:

As of Git 1.8.0:

git branch -u upstream/foo

Or, if local branch foo is not the current branch:

git branch -u upstream/foo foo

Or, if you like to type longer commands, these are equivalent to the above two:

git branch --set-upstream-to=upstream/foo

git branch --set-upstream-to=upstream/foo foo

As of Git 1.7.0:

git branch --set-upstream foo upstream/foo

Notes:

All of the above commands will cause local branch foo to track remote branch foo from remote upstream. The old (1.7.x) syntax is deprecated in favor of the new (1.8+) syntax. The new syntax is intended to be more intuitive and easier to remember.


See also: Why do I need to do `--set-upstream` all the time?

  • 110
    Is "upstream" the name of the remote? i.e. what most would call "origin" by default? – Andrew Vit Jun 26 '10 at 6:30
  • 153
    @Andrew: Yes. git branch --set-upstream master origin/master would be equivalent to what is automatically done when you initially clone a repository. – Dan Moulding Jun 26 '10 at 10:09
  • 61
    On a related note, adding this to your gitconfig is awesome: "[push] default=tracking" this will make it so that pushes will go the same place that pulls come from :) – jpswain Dec 5 '10 at 4:31
  • 61
    I get "fatal: Not a valid object name: 'origin/master'." – joachim Mar 24 '11 at 22:07
  • 79
    git push -u origin foo via – Cotton Sep 21 '11 at 7:02

You can do the following (assuming you are checked out on master and want to push to a remote branch master):

Set up the 'remote' if you don't have it already

git remote add origin ssh://...

Now configure master to know to track:

git config branch.master.remote origin
git config branch.master.merge refs/heads/master

And push:

git push origin master
  • it is really required the remote and the branch in the push? I mean, you only need it if your checked out branch is not the one you want to push, right ? – Doppelganger Mar 2 '10 at 5:14
  • 5
    Yes - but from memory you may need to be explicit for the first push. Can easily be tested of course... :) – Paul Hedderly Jun 18 '10 at 20:57
  • +1 This is the answer for Windows users who are stuck with the msysgit "preview" that is pre 1.8. Thanks for that. – John Oct 16 '12 at 12:33
  • 3
    This is the only answer that worked for me. When I tried the accepted answer, to set the upstream remote for an existing branch, I got: error: the requested upstream branch 'upstream/master' does not exist. – Steve K May 13 '14 at 23:02
  • 3
    @SteveK that's most likely because your upstream is called origin and not upstream. – umläute Aug 11 '15 at 14:21

I do this as a side-effect of pushing with the -u option as in

$ git push -u origin branch-name

The equivalent long option is --set-upstream.

The git-branch command also understands --set-upstream, but its use can be confusing. Version 1.8.0 modifies the interface.

git branch --set-upstream is deprecated and may be removed in a relatively distant future. git branch [-u|--set-upstream-to] has been introduced with a saner order of arguments.

It was tempting to say git branch --set-upstream origin/master, but that tells Git to arrange the local branch "origin/master" to integrate with the currently checked out branch, which is highly unlikely what the user meant. The option is deprecated; use the new --set-upstream-to (with a short-and-sweet -u) option instead.

Say you have a local foo branch and want it to treat the branch by the same name as its upstream. Make this happen with

$ git branch foo
$ git branch --set-upstream-to=origin/foo

or just

$ git branch --set-upstream-to=origin/foo foo
  • This is a much better solution imo – Nils_e Sep 7 '17 at 4:51

You might find the git_remote_branch tool useful. It offers simple commands for creating, publishing, deleting, tracking & renaming remote branches. One nice feature is that you can ask a grb command to explain what git commands it would execute.

grb explain create my_branch github
# git_remote_branch version 0.3.0

# List of operations to do to create a new remote branch and track it locally:
git push github master:refs/heads/my_branch
git fetch github
git branch --track my_branch github/my_branch
git checkout my_branch
  • 4
    is grb a standard command? Available in which package? – Jaseem Apr 20 '12 at 3:01
  • 3
    grb is a ruby gem that can be accessed as explained on their github – mcabrams Mar 18 '13 at 20:26
  • 4
    The OP is asking question about Git itself. So don't introduce a new tool would probably be better. – zeekvfu May 18 '14 at 2:25
  • grb is an alias for git-rebase on my macOS installation. I didn't do this :) – highmaintenance Mar 9 at 12:12

Actually for the accepted answer to work:

git remote add upstream <remote-url>
git fetch upstream
git branch -f --track qa upstream/qa
# OR:
git branch --set-upstream qa upstream/qa
  • The local branch was already tracking a branch, so we can assume the remote repo was already added. – Doppelganger May 18 '11 at 21:15
  • Dopplerganger: See joachim's comment to the accepted answer. Anyway assumptions readily differ - it what makes things so interesting ;) – Hedgehog Jun 13 '11 at 23:20

I believe that in as early as Git 1.5.x you could make a local branch $BRANCH track a remote branch origin/$BRANCH, like this.

Given that $BRANCH and origin/$BRANCH exist, and you've not currently checked out $BRANCH (switch away if you have), do:

git branch -f --track $BRANCH origin/$BRANCH

This recreates $BRANCH as a tracking branch. The -f forces the creation despite $BRANCH existing already. --track is optional if the usual defaults are in place (that is, the git-config parameter branch.autosetupmerge is true).

Note, if origin/$BRANCH doesn't exist yet, you can create it by pushing your local $BRANCH into the remote repository with:

git push origin $BRANCH

Followed by the previous command to promote the local branch into a tracking branch.

  • 1
    git push origin $BRANCH was what I was looking for. – User Apr 2 '13 at 15:15
  • After trying all sorts of solutions, including setting up an upstream as described above nothing worked. All I wanted to do is pull 1 new commit into my local branch from a remote one and I didn't setup tracking initially. The command git branch -f --track $BRANCH origin/$BRANCH does the trick. – DemitryT Feb 13 '14 at 15:08

1- update your local meta-data using : git fetch --all

enter image description here

2- show your remote and local branches using : git branch -a , see the following Screenshot

enter image description here

3- switch to target branch , that you want to linked with the remote: using

git checkout branchName

example :

enter image description here

4- Link your local branch to a remote branch using:

git branch --set-upstream-to nameOfRemoteBranch

N.B : nameOfRemoteBranch : to copy from the output of step 2 " git branch -r "

Example of use:

enter image description here

  • It worked. Thank you – Rahal Kanishka Aug 29 '17 at 6:12
  • Mostly easy and simple answer. – vibs2006 Aug 30 '17 at 6:26

Make sure you run :

git config push.default tracking

to be able to push trouble free

  • 1
    This could be convenient. We could note, however, that according to git-config(1) manual page, tracking is deprecated synonym of upstream. – FooF Aug 8 '12 at 2:39

Editing .git/config is probably the easiest and fastest way. That's what the Git commands for handling remote branches are doing, anyway.

If you don't want to muck with the file by hand (and it's not that hard to do), you can always use git config to do it...but again, that's just going to edit the .git/config file, anyway.

There are, of course, ways to automatically track a remote branch when using git checkout (by passing the --track flag, for example), but these commands work with new branches, not existing ones.

In very short

git branch --set-upstream yourLocalBranchName origin/develop

This will make your yourLocalBranchName track the remote branch called develop.

  • 1
    @Quincy Check greg's answer - use git push -u origin branch (or --set-upstream-to) instead – Tobias Kienzler May 28 '13 at 8:37
  • @MadNik, what is the difference between --set-upstream and --track? I don't quite understand why I should use one over the other. – A-B-B Mar 31 '14 at 18:30

For 1.6.x, it can be done using the git_remote_branch tool:

grb track foo upstream

That will cause Git to make foo track upstream/foo.

Here, using github and git version 2.1.4, just do:

$ git clone git@github.com:user/repo.git

And remotes come by itelsef, even if not linked locally:

$ git remote show origin

* remote origin
  Fetch URL: git@github.com:user/repo.git
  Push  URL: git@github.com:user/repo.git
  HEAD branch: master
  Remote branches:
    develop tracked         <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
    master  tracked
  Local branch configured for 'git pull':
    master merges with remote master
  Local ref configured for 'git push':
    master pushes to master (up to date)

But of course, still no local branch:

$ git branch
* master                  <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<

See? Now if you just checkout develp, it will do the magic automatically:

$ git checkout develop
Branch develop set up to track remote branch develop from origin.
Switched to a new branch 'develop'

So easy!


Summary. Just run this 2 commands:

$ git clone git@github.com:user/repo.git
$ git checkout develop
  • 1
    An excellent example of my identical use case. Despite no sign of a local 'develop' branch, when I checked out the 'develop' branch that branch appears and is magically set up to track the remote branch 'develop' from origin. I appreciate the step by step example and explanation! – ElliotPsyIT Mar 27 at 20:48

Use '--track' Option

  • After a git pull :

    git checkout --track <remote-branch-name>

  • Or:

    git fetch && git checkout <branch-name>

For creating new branch, we could use following command

 git checkout --track -b example origin/example 
For the already created branch to create link between remote then from that branch use below command

 git branch -u origin/remote-branch-name

In a somewhat related way I was trying to add a remote tracking branch to an existing branch, but did not have access to that remote repository on the system where I wanted to add that remote tracking branch on (because I frequently export a copy of this repo via sneakernet to another system that has the access to push to that remote). I found that there was no way to force adding a remote branch on the local that hadn't been fetched yet (so local did not know that the branch existed on the remote and I would get the error: the requested upstream branch 'origin/remotebranchname' does not exist).

In the end I managed to add the new, previously unknown remote branch (without fetching) by adding a new head file at .git/refs/remotes/origin/remotebranchname and then copying the ref (eyeballing was quickest, lame as it was ;-) from the system with access to the origin repo to the workstation (with the local repo where I was adding the remote branch on).

Once that was done, I could then use git branch --set-upstream-to=origin/remotebranchname

I use the following command (Suppose your local branch name is "branch-name-local" and remote branch name is "branch-name-remote"):

$ git branch --set-upstream-to=branch-name-local origin/branch-name-remote

If both local and remote branches have the same name, then just do the following:

$ git branch --set-upstream-to=branch-name origin/branch-name

This isn't a direct answer to this question, but I wanted to leave a note here for anyone who may be having the same issue as me when trying to configure an upstream branch.

Be wary of push.default.

With older git versions, the default was matching, which would cause very undesirable behaviour if you have, for example:

Local branch "master" tracking to origin/master

Remote branch "upstream" tracking to upstream/master

If you tried to "git push" when on the "upstream" branch, with push.default matching git would automatically try to merge the local branch "master" into "upstream/master", causing a whole lot of chaos.

This gives more sane behaviour:

git config --global push.default upstream

  • You did not leave this in vain. Thanks. – stefgosselin Feb 16 '17 at 20:26

or simply by :

switch to the branch if you are not in it already:

[za]$ git checkout branch_name

run

[za]$ git branch --set-upstream origin branch_name
Branch origin set up to track local branch brnach_name by rebasing.

and you ready to :

 [za]$ git push origin branch_name

You can alawys take a look at the config file to see what is tracking what by running:

 [za]$ git config -e

It's also nice to know this, it shows which branches are tracked and which ones are not. :

  [za]$ git remote show origin 

This would work too

git branch --set-upstream-to=/< remote>/< branch> < localbranch>

protected by BЈовић May 9 '12 at 13:33

Thank you for your interest in this question. Because it has attracted low-quality or spam answers that had to be removed, posting an answer now requires 10 reputation on this site (the association bonus does not count).

Would you like to answer one of these unanswered questions instead?

Not the answer you're looking for? Browse other questions tagged or ask your own question.