Skip to main content

My Git Setup on Windows

This is kind of a continuation of my earlier post about my terminal/shell on OS X and Linux.

As I was recently preparing for my Git on Windows talk, I naturally started tweaking the setup on Windows as well in the same direction, and I figured I'd share this setup.

Installing Git

Either go with Git for Windows, or Git Extensions if you want more GUI as well as Visual Studio integration. I personally have grown a distaste for TortoiseGit, as it sometimes locks files in my repositories. But it's supposed to be good otherwise (as an alternative for Git Extensions).

Git Extensions

During the Git install, you need to select the scary red option, for integrating Git into Windows cmd-line, if you want to use it from Powershell/Console2 (we'll get back to that later). The cygwin-like Git Bash is not sexy.
Update (30/4 2012)I think you could also wrap Console2 around Cygwin, although I haven't tried this myself yet. This way you can avoid the scary red option. There's also the alternative mintty terminal for Cygwin.
You also get asked how Git should treat line endings. There are three options, you'll need to pick the one that suits you best (you can change it later):
  • Windows style (convert to CRLF on checkout, and to unix on checkin, autocrlf true): Pick this one if you have programs that need to CRLF (notepad, scripts, tools).
  • Checkout as -is, commit unix style (autocrlf input): All your programs can deal with LF just fine. This is the Github recommends this one. 
  • Checkout as-is, commit as-is (autocrlf false): You’re OK with everything ending up like CRLF - this is OK for pure Windows environments. It is not cross platform friendly.

Authing against Github with Putty


It is possible to get away with using the OpenSSH that installs along with Git, but as far as I know that will only work for command-line, and not for GUI tools. The Github docs explain that Putty is not supported for SSH auth, but that's bollocks. It works just fine.

Download and install Putty (you'll want the Windows installer for everything except PuTTYtel option).

If you're unfamiliar with the Putty tools, I'm not going to go too much into it, but you're gonna:
  • Use puttygen for generating a SSH key
  • Run pageant in the background, serving ssh-authentication (for any program that might ask, like Git Extensions, or TortoiseGit)
  • Offer plink to the git command line as an authentication method (GIT_SSH)
When you generate a key in Putty, make sure you have at least 768 bits in the RSA key (2048 is good). Any less, and Github (and probably most other SSH servers) will reject the authentication without any explanation.

Generating a key with putty
After the key is generated, copy and paste the public key into your SSH keys in your Github settings.

Save the private key file as $HOME/keys/id_rsa.pkk or something like that.

Open Putty/Pageant, go Add Key, and select the pkk file you just saved.

Set an environment variable called GIT_SSH to point at C:\Program Files (x86)\PuTTY\plink.exe or wherever you installed Putty/plink.

Open a command line window and do


git clone [one of your github repos SSH urls]

This should work with no problem. If it doesn't work, something has gone wrong in the setup:
  • Pageant isn't running with the right key
  • You didn't set up GIT_SSH properly (echo %git_ssh% to check)
  • You didn't paste the key correctly into the Github settings
  • You generated a key with less than 768 bits
Update (01.05.2012): If you run into this error message: 
The server's host key is not cached in the registry. Youhave no guarantee that the server is the computer youthink it is. 
It means that Github's SSH server needs to be authorized (I actually only noticed this when cloning from Gitorious, never saw it from Github). People usually solve this by doing an ssh git@server.com, and answering yes when prompted, but since Putty keeps its authorized keys in a different place, you have to: 
  • Open Putty
  • Enter git@server.com in the Host Name field
  • Pick Never under 'Close window on exit'
  • Select Open. 
  • Click yes when the question pops. You should see something like this:
Using username "git".Authenticating with public key "rsa-key-20120429" from agentServer refused to allocate ptyHi tfnico! You've successfully authenticated, but GitHub does not provide shell access. 
Now cloning should work.

Note that if you want to skip SSH entirely (I've actually seen company firewalls that block SSH), and just use Smart HTTP authentication (https). You'll get asked for password each time, so specify the credentials in your home-directory, in a file called _netrc like this:


machine github.com
login tfnico
password sekrit


Note that the password value is not very friendly towards special characters. But hey, if you wanted security, you should've gone with SSH instead.

The console window

First thing up is Console2. It's a wrapper of the normal command-line in Windows, which still, oh so many years later, sucks really hard. Console2 has tabs, sensible copy/paste, and nicer color options. Scott Hanselman has pretty much summed up the useful tweaks, and I won't add much else than a screenshot.

Console2 with Poweshell & git-posh

Key steps are:
  • Paste this Solarized color theme into your Console2 config
  • Pick a nicer font (Lucida console?)
  • Use Powershell as shell (because of posh-git)
  • Remove unnecessary toolbars and menus
  • Enable Copy-on-select
  • Remap New Tab (Ctrl + T) and Paste (Ctrl + V)
  • Install posh-git (shows repo status in PS1, requires Powershell)
The posh-git prompt is a bit sluggish (although much better than the first time I tried it), but all in all, Console2 is really comfy, and this setup works pretty sweet. 

Comments

  1. Just a quick follow-up, I think you could also wrap Console2 around Cygwin, although I haven't tried this myself yet.

    There's also the alternative mintty terminal for Cygwin.

    ReplyDelete
  2. Another note: Github just released Github-for-windows, which should make it pretty easy to get up and running quickly.

    ReplyDelete
  3. Anonymous5/1/13 17:51

    What about hostnames in the tabs? No point in having tabs with hostnames.

    ReplyDelete
  4. @Anonymous: Not sure what you mean there, or how hostnames are relevant to this post.

    ReplyDelete

Post a Comment

Popular posts from this blog

Open source CMS evaluations

I have now seen three more or less serious open source CMS reviews. First guy to hit the field was Matt Raible ( 1 2 3 4 ), ending up with Drupal , Joomla , Magnolia , OpenCms and MeshCMS being runner-ups. Then there is OpenAdvantage that tries out a handful ( Drupal , Exponent CMS , Lenya , Mambo , and Silva ), including Plone which they use for their own site (funny/annoying that the entire site has no RSS-feeds, nor is it possible to comment on the articles), following Matt's approach by exluding many CMS that seem not to fit the criteria. It is somewhat strange that OpenAdvantage cuts away Magnolia because it "Requires J2EE server; difficult to install and configure; more of a framework than CMS", and proceed to include Apache Lenya in the full evaluation. Magnolia does not require a J2EE server. It runs on Tomcat just like Lenya does (maybe it's an idea to bundle Magnolia with Jetty to make it seem more lightweight). I'm still sure that OpenAdvant

Git Stash Blooper (Could not restore untracked files from stash)

The other day I accidentally did a git stash -a , which means it stashes *everything*, including ignored output files (target, build, classes, etc). Ooooops.. What I meant to do was git stash -u , meaning stash modifications plus untracked new files. Anyhows, I ended up with a big fat stash I couldn't get back out. Each time I tried, I got something like this: .../target/temp/dozer.jar already exists, no checkout .../target/temp/core.jar already exists, no checkout .../target/temp/joda-time.jar already exists, no checkout .../target/foo.war already exists, no checkout Could not restore untracked files from stash No matter how I tried checking out different revisions (like the one where I actually made the stash), or using --force, I got the same error. Now these were one of those "keep cool for a second, there's a git way to fix this"situation. I figured: A stash is basically a commit. If we look at my recent commits using   git log --graph --

Leaving eyeo

Thirteen blog posts later, this one notes my departure from eyeo after 4 years and 3 months. I joined eyeo around the headcount of 80 employees, and now I think there's just over 250 people there. My role coming in was as operations manager, doing a mix of infrastructure engineering and technical project management. I later on took on organizational development to help the company deal with its growing pains . We introduced cross-functional teams, departments (kind of like guilds), new leadership structures, goal-setting frameworks, onboarding processes and career frameworks.  And all of this in a rapidly growing distributed company. I'm proud and happy that for a long time I knew every employee by name and got to meet every single new-hire through training them on company structure and processes.  At some point, we had enough experienced leaders and organizational developers that I could zoom back in on working in one team, consulting them on  Git and continuous integration

Managing dot-files with vcsh and myrepos

Say I want to get my dot-files out on a new computer. Here's what I do: # install vcsh & myrepos via apt/brew/etc vcsh clone https://github.com/tfnico/config-mr.git mr mr update Done! All dot-files are ready to use and in place. No deploy command, no linking up symlinks to the files . No checking/out in my entire home directory as a Git repository. Yet, all my dot-files are neatly kept in fine-grained repositories, and any changes I make are immediately ready to be committed: config-atom.git     -> ~/.atom/* config-mr.git     -> ~/.mrconfig     -> ~/.config/mr/* config-tmuxinator.git       -> ~/.tmuxinator/* config-vim.git     -> ~/.vimrc     -> ~/.vim/* config-bin.git        -> ~/bin/* config-git.git               -> ~/.gitconfig config-tmux.git       -> ~/.tmux.conf     config-zsh.git     -> ~/.zshrc How can this be? The key here is to use vcsh to keep track of your dot-files, and its partner myrepos/mr for o

Git tools for keeping patches on top of moving upstreams

At work, we maintain patches for some pretty large open source repositories that regularly release new versions, forcing us to update our patches to match. So far, we've been using basic Git operations to transplant our modifications from one major version of the upstream to the next. Every time we make such a transplant, we simply squash together the modifications we made in the previous version, and land it as one big commit into the next version. Those who are used to very stringent keeping of Git history may wrinkle their nose at this, but it is a pragmatic choice. Maintaining modifications on top of the rapidly changing upstream is a lot of work, and so far we haven't had the opportunity to figure out a more clever way to do it. Nor have we really suffered any consequences of not having an easy to read history of our modifications - it's a relatively small amount of patches, after all. With a recent boost in team size, we may have that opportunity. Also the need for be