Apr 30 2008

Getting Started with Git and GitHub on Windows

Published by at 9:51 am under Technology   

(Update: I have a new, related post about the Best Git GUIs for Windows.)

I’ve been attracted to, and trying out, various distributed source control tools for the last two years, and have come to the conclusion that the most likely “winner” is Git. Git does a great many things right, good progress is being made in the few areas it is weak, and it has rapidly growing popularity. There are many web sites with extensive information about using Git, learning Git, Git integration, and more.

For new Oasis Digital projects, we will generally Git rather than SVN for source control. Here are instructions I wrote to help our teams get started. The contents here are 95% generic, but the references to me are, of course, Oasis-Digital-specific.

(For a general introduction to Git, consider this video at GitHub.)

GitHub

Although Git is a fully distributed source control system, it is very convenient to have a set of robust, central repositories. Oasis Digital’s repositories are hosted by GitHub:

http://github.com/

Github offers a useful set of online features to supplement what Git has built in and available locally. As of the spring of 2008, GitHub is certainly a work-in-progress, I’d characterize is as a “beta” level service. Nonetheless it is worthwhile and recommended. There is a lot to learn from the “guides” published here also:

http://github.com/guides

Install and Configure msysGit on Windows

I assume here that you are using Windows, although Git works very well (better, actually) on Linux or Mac. As I write this, the best Windows Git package is msysgit, available here:

http://code.google.com/p/msysgit/

Make sure to follow the download instructions labeled “If you only want to use Git”. As I write this the download is Git-1.5.5-preview20080413.exe, but get the current version available as you read this instead, not that specific version.

Install by running the EXE installer. Accept the default install directory. When you get to the PATH setting screen, I recommend the “Use Git Bash only” setting, because it avoid any risk of PATH conflicts.

By default, Git will be configured to translate text files between Windows CRLFs (in your working copy) and Unix LFs (in repositories). This setting is fine if you like to use an editor on Windows that insists on Windows CRLFs. I generally use an editor that is equally happy to use Unix LFs, so I sometimes use Git in the other (non-translating) mode.

msysgit includes both the git command line, and a usable GUI. The GUI is not on par with more mature products, but it is helpful and good enough for users who are allergic to the command line.

Create your SSH Key

The first step in using Git is to create your SSH Key. This will be used to secure communications between your machine and other machines, and to identify your source code changes. (If you already have an SSH key for other reasons, you can use it here, there is nothing Git-specific about this.)

In Windows Explorer, pick any convenient directory, right-click, and choose “Git Bash Here”.

Then type this command:

(with your own email address, of course)

Accept the default key file location. When prompted for a passphrase, make one up and enter it. If you feel confident that your own machine is secure, you can use a blank passphrase, for more convenience and less security. Note where it told you it stored the file. On the machine I tested with, it was stored in “C:\Documents and Settings\Kyle\.ssh\”

Open the file id_rsa.pub with a text editor. The text in there is your “public SSH key”. You will need it to set up your GitHub account, in the next section.

Beware of $HOME trouble: a reader reported a tricky failure mode in which some other software he installed had set up a HOME or HOME_PATH environment variable pointing in to that application instead of to your real home (“Documents and Settings”) directory.

More details on the key process are available here:

http://github.com/guides/providing-your-ssh-key

Set up your GitHub account

Go to http://github.com/ and sign up for a free account. In the sample here I signed up with a made-up alter-ego, harry@kylecordes.com. Use your own, real email address of course.

Don’t worry that GitHub describes the free account as for “open source” work; I will later add you as a collaborator to my paid (and therefore private, non-open-source) projects. Make sure to copy-paste in your SSH public key that you created earlier.

Once you have set up your github account, email your github username (not your password) to me, so I can add you to the relevant project(s). (Reminder – send to me only if you are working on an Oasis Digital project! If you are using this page as generic Git instructions, send the information to your project leader instead!)

Once I have added you as a collaborator to the relevant project and sent back its URL, you can navigate to the URL, which will look like this:

https://github.com/kylecordes/PROJECTNAME/tree/master

On that page, click the “fork” button to create your own workspace for the project. This will take you to your own page for the project, something like this:

https://github.com/YOURNAME/PROJECTNAME/tree/master

Now you can clone this project to your own machine, as discussed below.

Getting Started Locally

First, use the “Git Bash Here” feature described above, to get a command prompt. Tell Git about your name and email address:


git config --global user.email Your.Email@domain.com
git config --global user.name "Your Real Name"

Then you are ready to proceed with getting into a project. Copy the “Clone URL” from a github project page. Make a new directory on your machine, to become your working directory. There are two approaches to which project to clone.

  1. Clone from your own fork repo. This will make it trivial to push your changes up, but require one more command to get upstream changes.
  2. Clone from the upstream (my) repo. This will make it trivial to get change, but require one more command to be able to push changes, because you can’t push to another Github users’ repo.

I assume later in these instructions that you chose #1.

Next, get your local clone by clicking, or by typing.

Approach 1: GUI

In Windows Explorer, Right click the working directory and choose “Git GUI Here”.

Choose “Clone Existing Repository” in the dialog that comes up:

Paste the URL that you copied above from GitHub. Note that in the screenshot I show it as if you clone your repo, while I think it’s slightly easier overall to clone the upstream repo. Thus it really should show git@githib.com:kylecordes/sample1.git instead.
Note that your browser might add an erroneous mailto: to the URL, which you must remove – Git URLs do not start with “mailto”. Enter the directory where you want your working copy:

Make sure to use real, reasonable values. For example, you are not working “sample1” and you probably don’t keep your working projects in a directory named “GitStuff”, so put in a directory that makes sense for the project you are working on. Also, put your working copy in a place where you can effectively work in it; for example the working copy for a web project should usually be under the webroot of your local development web server.

Click Clone. You will be prompted for your passphrase if you used one. In a few minutes the Clone will finish, and you have the project available on your machine. I’ve had sporadic problems with this process hanging (growing pains at GitHub are the likely cause), so if you don’t see progress for a few minutes, stop it and start over.

Approach 2: Command Line

I find this easier. In Windows Explorer, right-click on the working directory you want and choose “Gui Bash Here”. Then enter a command like this:

git clone repoURL

Git might prompt you about an SSH key, the first time you do this with github (or any other new server). Answer “yes”.

It’s worth pointing out here, if you didn’t already understand from the various Git web sites, that Git is a distributed source control system. It will pull down the whole project history, so you can browse history and even commit changes without online access. Thus Git works very well if you have an intermittent or poor network connection.

Work Flow

As with all source control, work in the directory where you use source control. Do not copy files back and forth between here and some other working directory, that is a path to endless merge and update problems.

Once you have checked out the software, here is a summary of your work flow. For more details, please read the copies Git documentation online. I suggest reading both the official Git material, as well as other sites and articles about Git.

Getting Changes

Get changes from others with “git pull” (or using the GUI). By default this will pull from the repo from which you cloned, so if you cloned the upstream repo, that will get other peoples’ changes.

If you cloned from your own Github repo, you’ll need to use something like this:


git remote add upstream git@github.com:kylecordes/sample1.git
git pull kyle upstream

Sending Changes

Commit your changes locally with “git commit” (or using the GUI). Remember that Git generally wants you to explicitly say which files’ changes to include (“git add”), so make sure you read and understand enough about Git to do this properly; it is only a few commands or clicks in the GUI. The usual caveat applies, to only commit actual source files, not generated files or temp files.

Push your changes up to your GitHub repository with “git push”. This step will make it so others on your project can see your changes. Do this at least once per day, and ideally more often as you collaborate. Assuming that you cloned from the upstream repo, you’ll need to set up a reference to your own Github repo (the one you can push to), with something like this:


git remote add harry git@github.com:harrycordes/odtimetracker.git

As usual, use reasonable names and relevant URLs, not my sample names and URLs. Once you’ve added the remote reference, pushing is easy:


git push harry master

When you have a set of changes (one or more commits) that you think are ready to go in to the main-line of the project, use Github to issue a “pull request”. Your project lead (me, typically, at Oasis Digital) will review your commits and either pull them in to the main-line, or send feedback about changes needed before they can be pulled in.

A key thing to understand about Git is that it makes branching extremely easy and fast, so that very convenient to use branches. If you are accustomed to other source control systems where branching is a big, painful thing, it will be very different for you in Git. Once you learn to use branches, you’ll sometimes push up a branch you are working on instead of master.

I’ve only scratched the surface in this introduction. You now have Git up and running with project code in it, so pick up a Git tutorial or reference (such as the screencast videos at GitCasts) and start learning.

To Learn More

I heartily recommend the “Illustrated Guide to Git on Windows“. It doesn’t yet cover GitHub, but does cover many more details of using Git itself.

Also, a bit of Git can be very useful even in a project that uses SVN, especially when you need to rearrange a bunch of files in SVN.

Update: In a newer post, I list several other Git GUIs for Windows.

If you found this post useful, please link to it from your web site, mention it online, or mention it to a colleague.

22 responses so far

22 Responses to “Getting Started with Git and GitHub on Windows”

  1. Mike Pence says:

    Nice work, Kyle!

  2. Git on Windows, now for Adobe Air…

    Just picked up this detailed post for using git on Windows, thought I’d share it here too. And just in time as well, I’ve spent a lot of time the last couple of days reading up on Adobe Air and making notes of possible applications I can pl…

  3. Panda says:

    Nice, ssh-keygen -C "myemail@gmail.com" -t rsa
    BTW Following your instructions exactly give me this when I hit return after typing this command:
    syntax error near unexpected token ‘newline’

  4. Kyle Cordes says:

    I see you were typing the “code” HTML tag… which was a WordPress formatting problem,which I’ve now fixed in the directions above. The actual command is just:

    ssh-keygen -C “myemail@gmail.com” -t rsa

  5. Hi Kyle,

    This is an awesome post! I am just getting started with Git and needed to ask that if there is a way to host the repository on my personal server. I know you have used Github to host your repository but I am wondering if I can do this on my own server.

    Thanks,
    Azam

  6. Kyle Cordes says:

    You can read a bit about settings up a Git repository on a server here:

    https://37s.backpackit.com/pub/1465067

    I also plan to post sometime in the next month or two about Gitosis, which I’ve found to be a much better approach.

  7. Gaius says:

    Is there a way to remember the password so I don’t have to type it in every time I pull/push? I’m used to Git on my OSX box, which has a lockable keychain.

  8. Kyle Cordes says:

    > remember the password?

    I haven’t set this up myself using the SSH in msys, but it is almost certainly there. I have set it up with PuTTY, where it works well.

  9. JohnB says:

    FYI: when I ran it, the lines to set my global name and email needed two dashes in front of the word ‘global’ – not just one as seems to be shown here.

    In any case, thanks for this helper starter page.

  10. Charlie Park says:

    Where you have “git config –global user.email Your.Email@domain.com“, that en-dash should be two dashes: “–global”

    I’m not sure if the blog will turn those two dashes into a single longer dash, but I thought I’d add that in here.

    Thanks for the tutorial.

  11. Richard Muller says:

    Thanks for such a great write-up. It was a pleasure to follow it.

  12. Richard Muller says:

    I downloaded and installed the Git stuff, but one problem for me is getting back in *nix kind of stuff. I wonder if merely setting RAILS_GEM_VERSION = ‘x.x.x’ at the beginning of config.rb will allow me to test my Rails about against version x.x.x? Do you see any problem with that approach?

  13. Is there a way to make git remember my password when i push
    im using windows vista cmd.exe

  14. Here is a little exercise / tutorial / warm-up for someone starting out with Git. If you’re anyting like me you may find the tutorials etc. on git.or.cz a bit daunting. I recommend you try this after reading the user manual but before tearing your hair out trying to follow all the examples in the user manual. After you’ve followed this simple workflow, then go back to the more advanced stuff in the tutorials and user manuals (like cloning repositories and creating and merging branches).

    I created this exercise to try and model our workflow and what we wanted to use git for = tracking a project with multiple files where the filebase might change frequently from one version to the next. (For more on my first engagement with Git, see previous blog entry!)

    http://siliconmouth.wordpress.com/category/nerdy/

    look for December 27, 2008 or “git warmup”

  15. By the way Kyle, thanks for the awesome intro to Git, you sure helped reassure me that windows support existed and your testimony encouraged me that it could work for us too!

    cheers,
    Conor

  16. Patrick says:

    If you get the error:
    error could not lock config file .git config: no such file or directory
    then you should check if you used the two dashes “–” or if you have one dash only “-“.

    I ran into this error, but the blog was not very clear about this thing. Furthermore, great info… thanks.

  17. P says:

    Kyle, for future reference, any time you want a clean screenshot of the active window, press alt+prtsc. It’ll save you from having to do time consuming cropping.

  18. Kyle Cordes says:

    Ceyhun – thanks for the tip. I have ample screenshot technology in hand, including Alt-printscreen, manual trimming, various screengrab tools, etc.

  19. Windows users who are part of a domain, might have to check their HOMESHARE directory for the generated .ssh directory. This environment variable does not appear in the System Properties dialog. To see or navigate to this directory, enter the path %HOMESHARE% into Windows Explorer.

  20. PalaDolphin says:

    In reading your instructions for Git, you lost me at “Getting Started Locally”.

    After the ‘git config’ commands, you have this “Git speak” that you don’t explain:

    ‘Copy the “Clone URL” from a github project page.’
    {I see no “Clone” anywhere on their page.}

    (….)

  21. Kyle Cordes says:

    The above comment reminded me to mention this Git introduction:

    http://learn.github.com/p/intro.html

  22. ignaci says:

    It’s a good guide for Windows folks willing to try some distributed dev.
    Check this one too: http://codicesoftware.blogspot.com/2010/03/distributed-development-for-windows.html, there’s more to distributed version control than Git and Mercurial out there.