Skip to content


Subversion checkout URL

You can clone with
Download ZIP
hub helps you win at git.
Go Cucumber Shell Ruby Batchfile

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.

hub: git + hub = github

hub is a command line utility which adds GitHub knowledge to git.

It can used on its own or as a git wrapper.


$ hub clone rtomayko/tilt

Expands to:
$ git clone git://

Wrapping git:

$ git clone rack/rack

Expands to:
$ git clone git://

hub requires you have git installed and in your $PATH. It also requires Ruby 1.8.6+ or Ruby 1.9.1+. No other libraries necessary.



hub is most easily installed as a standalone script:

curl -s > ~/bin/hub &&
chmod 755 ~/bin/hub

Assuming ~/bin/ is in your $PATH, you're ready to roll:

$ hub version
git version
hub version 0.3.2


brew install hub


Though not recommended, hub can also be installed as a RubyGem:

$ gem install git-hub

(Yes, the gem name is git-hub.)

(It's not recommended because of the RubyGems startup time. See this gist for information.)

Standalone via RubyGems

Yes, the gem name is still git-hub:

$ gem install git-hub
$ hub hub standalone > ~/bin/hub && chmod 755 ~/bin/hub
$ gem uninstall git-hub


You can also install from source:

$ git clone git://
$ cd hub
$ rake install prefix=/usr/local


hub works best when it wraps git. This is not dangerous - your normal git commands should all work. hub merely adds some sugar.

Typing hub alias <shell> will display alias instructions for your shell. hub alias alone will show the known shells.

For example:

$ hub alias bash
Run this in your shell to start using `hub` as `git`:
  alias git=hub

You should place this command in your .bash_profile or other startup script to ensure runs on login.

The alias command can also be eval'd directly using the -s flag:

$ eval `hub alias -s bash`


Assuming you've aliased hub to git the following commands now have superpowers:

git clone

$ git clone schacon/ticgit
> git clone git://

$ git clone -p schacon/ticgit
> git clone

$ git clone resque
> git clone git://

$ git clone -p resque
> git clone

git remote add

$ git remote add rtomayko
> git remote add rtomayko git://

$ git remote add -p rtomayko
> git remote add rtomayko

$ git remote add origin
> git remote add origin git://

git init

$ git init -g
> git init
> git remote add origin

git push

$ git push origin,staging,qa bert_timeout
> git push origin bert_timeout
> git push staging bert_timeout
> git push qa bert_timeout

git browse

$ git browse
> open

$ git browse schacon/ticgit
> open

$ git browse -p schacon/ticgit
> open

$ git browse resque
> open

$ git browse -p resque
> open

git help

$ git help
> (improved git help)
$ git help hub
> (hub man page)

GitHub Login

To get the most out of hub, you'll want to ensure your GitHub login is stored locally in your Git config.

To test it run this:

$ git config --global github.user

If you see nothing, you need to set the config setting:

$ git config --global github.user YOUR_USER

See for more information.


If you prefer http:// clones to git:// clones, you can set the hub.http-clone option using git-config.

For example:

$ git clone defunkt/repl
< git clone >
$ git config --global --add hub.http-clone yes
$ git clone defunkt/repl
< http clone >

Or you can enter this manually into your ~/.gitconfig file:

$ cat ~/.gitconfig
  http-clone = yes

Prior Art

These projects also aim to either improve git or make interacting with GitHub simpler:


Once you've made your great commits:

  1. Fork hub
  2. Create a topic branch - git checkout -b my_branch
  3. Push to your branch - git push origin my_branch
  4. Create an Issue with a link to your branch
  5. That's it!



Chris Wanstrath :: :: @defunkt

Something went wrong with that request. Please try again.