hub ruby Rubygems

hub introduces git to GitHub

5 years after

git + hub = github

hub is a command line tool that wraps git in order to extend it with extra features and commands that make working with GitHub easier.

$ hub clone rtomayko/tilt

# expands to:
$ git clone git://

hub is best aliased as git, so you can type $ git <command> in the shell and get all the usual hub features. See "Aliasing" below.



  • git 1.7.3 or newer
  • Ruby 1.8.6 or newer


Installing on OS X is easiest with Homebrew:

$ brew install hub


hub is easily installed as a standalone script:

$ curl -sLo ~/bin/hub &&
  chmod +x ~/bin/hub

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

$ hub version
git version 1.7.6
hub version 1.8.3


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

$ gem install hub

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

Standalone via RubyGems

$ gem install hub
$ hub hub standalone > ~/bin/hub && chmod +x ~/bin/hub

This installs a standalone version which doesn't require RubyGems to run, so it's faster.


You can also install from source:

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

Help! It's Slow!

Is your prompt slow? It may be hub.

  1. Check that it's not installed using RubyGems.

  2. Check that RUBYOPT isn't loading anything shady:

    $ echo $RUBYOPT
  3. Check that your system Ruby is speedy:

    $ time /usr/bin/env ruby -e0

If #3 is slow, it may be your GC settings.


Using hub feels best when it's aliased as git. This is not dangerous; your normal git commands will all work. hub merely adds some sugar.

hub alias displays instructions for the current shell. With the -s flag, it outputs a script suitable for eval.

You should place this command in your .bash_profile or other startup script:

eval "$(hub alias -s)"

Shell tab-completion

hub repository contains tab-completion scripts for bash and zsh. These scripts complement existing completion scripts that ship with git.


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

git clone

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

$ git clone -p schacon/ticgit
> git clone [email protected]:schacon/ticgit.git

$ git clone resque
> git clone [email protected]/YOUR_USER/resque.git

git remote add

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

$ git remote add -p rtomayko
> git remote add rtomayko [email protected]:rtomayko/CURRENT_REPO.git

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

git fetch

$ git fetch mislav
> git remote add mislav git://
> git fetch mislav

$ git fetch mislav,xoebus
> git remote add mislav ...
> git remote add xoebus ...
> git fetch --multiple mislav xoebus

git cherry-pick

$ git cherry-pick
> git remote add -f mislav git://
> git cherry-pick SHA

$ git cherry-pick [email protected]
> git remote add -f mislav git://
> git cherry-pick SHA

$ git cherry-pick [email protected]
> git fetch mislav
> git cherry-pick SHA

git am, git apply

$ git am
> curl -o /tmp/55.patch
> git am /tmp/55.patch

$ git am --ignore-whitespace
> curl -o /tmp/fdb9921.patch
> git am --ignore-whitespace /tmp/fdb9921.patch

$ git apply
> curl -o /tmp/gist-8da7fb575debd88c54cf.txt
> git apply /tmp/gist-8da7fb575debd88c54cf.txt

git fork

$ git fork
[ repo forked on GitHub ]
> git remote add -f YOUR_USER [email protected]:YOUR_USER/CURRENT_REPO.git

git pull-request

# while on a topic branch called "feature":
$ git pull-request
[ opens text editor to edit title & body for the request ]
[ opened pull request on GitHub for "YOUR_USER:feature" ]

# explicit title, pull base & head:
$ git pull-request "I've implemented feature X" -b defunkt:master -h mislav:feature

$ git pull-request -i 123
[ attached pull request to issue #123 ]

git checkout

$ git checkout
> git remote add -f -t feature git://github:com/mislav/hub.git
> git checkout --track -B mislav-feature mislav/feature

$ git checkout custom-branch-name

git merge

$ git merge
> git fetch git:// +refs/heads/feature:refs/remotes/mislav/feature
> git merge mislav/feature --no-ff -m 'Merge pull request #73 from mislav/feature...'

git create

$ git create
[ repo created on GitHub ]
> git remote add origin [email protected]:YOUR_USER/CURRENT_REPO.git

# with description:
$ git create -d 'It shall be mine, all mine!'

$ git create recipes
[ repo created on GitHub ]
> git remote add origin [email protected]:YOUR_USER/recipes.git

$ git create sinatra/recipes
[ repo created in GitHub organization ]
> git remote add origin [email protected]:sinatra/recipes.git

git init

$ git init -g
> git init
> git remote add origin [email protected]:YOUR_USER/REPO.git

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 -- commit/SHA
> open

$ git browse -- issues
> open

$ git browse schacon/ticgit
> open

$ git browse schacon/ticgit commit/SHA
> open

$ git browse resque
> open

$ git browse resque network
> open

git compare

$ git compare refactor
> open

$ git compare 1.0..1.1
> open

$ git compare -u fix
> (

$ git compare other-user patch
> open

git submodule

$ hub submodule add wycats/bundler vendor/bundler
> git submodule add git:// vendor/bundler

$ hub submodule add -p wycats/bundler vendor/bundler
> git submodule add [email protected]:wycats/bundler.git vendor/bundler

$ hub submodule add -b ryppl ryppl/pip vendor/pip
> git submodule add -b ryppl git:// vendor/pip

git help

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


GitHub OAuth authentication

Hub will prompt for GitHub username & password the first time it needs to access the API and exchange it for an OAuth token, which it saves in "~/.config/hub".

HTTPS instead of git protocol

If you prefer using the HTTPS protocol for GitHub repositories instead of the git protocol for read and ssh for write, you can set "hub.protocol" to "https".

# default behavior
$ git clone defunkt/repl
< git clone >

# opt into HTTPS:
$ git config --global hub.protocol https
$ git clone defunkt/repl
< https clone >


These instructions assume that you already have hub installed and aliased as git (see "Aliasing").

  1. Clone hub:
    git clone defunkt/hub && cd hub
  2. Install development dependencies:
    bundle install
  3. Verify that existing tests pass:
    bundle exec rake
  4. Create a topic branch:
    git checkout -b feature
  5. Make your changes. (It helps a lot if you write tests first.)
  6. Verify that tests still pass:
    bundle exec rake
  7. Fork hub on GitHub (adds a remote named "YOUR_USER"):
    git fork
  8. Push to your fork:
    git push -u YOUR_USER feature
  9. Open a pull request describing your changes:
    git pull-request


Prior art

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

Related Repositories



This sample shows you how to securely stream data directly to Azure IoT Hub from ...



Grav Course Hub with Git Sync, designed to support an open and collaborative fli ...



JetBrains Hub as a docker container ...



Docker image for Jetbrains HUB ...

Top Contributors

defunkt mislav stephencelis justinweiss cehoffman kch joliss rares rtomayko josh novas0x2a nicklewis qrush parndt akahn nocash benpickles bbinet calebthompson christian-oudard blueyed sferik evanphx segfaulthunter gorenje jfirebaugh joshthecoder justquick rkh inkel


-   v1.10.1 zip tar
-   v1.10.0 zip tar
-   v1.9.0 zip tar
-   v1.8.4 zip tar
-   v1.8.3 zip tar
-   v1.8.2 zip tar
-   v1.8.1 zip tar
-   v1.8.0 zip tar
-   v1.7.0 zip tar
-   v1.6.1 zip tar
-   v1.6.0 zip tar
-   v1.5.1 zip tar
-   v1.5.0 zip tar
-   v1.4.1 zip tar
-   v1.4.0 zip tar
-   v1.3.2 zip tar
-   v1.3.1 zip tar
-   v1.3.0 zip tar
-   v1.2.0 zip tar
-   v1.1.0 zip tar
-   v1.0.3 zip tar
-   v1.0.2 zip tar
-   v1.0.1 zip tar
-   v1.0.0 zip tar
-   v0.3.2 zip tar
-   v0.3.1 zip tar
-   v0.3.0 zip tar
-   v0.2.0 zip tar
-   v0.1.3 zip tar
-   v0.1.2 zip tar