command module
Version: v2.2.3+incompatible Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Jan 22, 2016 License: MIT Imports: 3 Imported by: 0


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

hub can be installed through Homebrew:

$ brew install hub
$ hub version
git version 1.7.6
hub version 2.2.0

hub can be easily installed as an executable. Download the latest compiled binaries and put it anywhere in your executable path.


To install hub from source, you need to have a Go development environment, version 1.4 or better:

$ git clone
$ cd hub
$ ./script/build
$ cp hub YOUR_BIN_PATH

Or, if you've done Go development before and your $GOPATH/bin directory is already in your PATH:

$ go get


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.

Installation instructions


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

$ git clone 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 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 --no-tags mislav git://
> git cherry-pick SHA

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

$ git cherry-pick mislav@SHA
> git fetch mislav
> git cherry-pick SHA
git am, git apply
$ git am
[ downloads patch via API ]
> git am /tmp/55.patch

$ git am --ignore-whitespace
[ downloads patch via API ]
> git am --ignore-whitespace /tmp/fdb9921.patch

$ git apply
[ downloads patch via API ]
> git apply /tmp/gist-8da7fb575debd88c54cf.txt
git fork
$ git fork
[ repo forked on GitHub ]
> git remote add -f YOUR_USER
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 -m "Implemented feature X" -b defunkt:master -h mislav:feature
git checkout
$ git checkout
> git remote add -f --no-tags -t feature mislav 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

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

$ git create recipes
[ repo created on GitHub ]
> git remote add origin

$ git create sinatra/recipes
[ repo created in GitHub organization ]
> git remote add origin
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 -- commit/SHA
> open

$ git browse -- issues
> open

$ git browse -- issues/10
> 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
$ git submodule add wycats/bundler vendor/bundler
> git submodule add git:// vendor/bundler

$ git submodule add -p wycats/bundler vendor/bundler
> git submodule add vendor/bundler

$ git submodule add -b ryppl --name pip ryppl/pip vendor/pip
> git submodule add -b ryppl --name pip git:// vendor/pip
git ci-status
$ git ci-status [commit]
> (prints CI state of commit and exits with appropriate code)
> One of: success (0), error (1), failure (1), pending (2), no status (3)
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".

To avoid being prompted, use GITHUB_USER and GITHUB_PASSWORD environment variables.

Alternatively, you may provide GITHUB_TOKEN, an access token with repo permissions. This will not be written to ~/.config/hub.

HTTPS instead of git protocol

If you prefer the HTTPS protocol for GitHub repositories, you can set "hub.protocol" to "https". This will affect clone, fork, remote add and other operations that expand references to GitHub repositories as full URLs that otherwise use git and ssh protocols.

"hub.protocol" only applies when the "OWNER/REPO" shorthand is used instead of a full git URL.

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

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

By default, hub will only work with repositories that have remotes which point to GitHub Enterprise hosts need to be whitelisted to configure hub to treat such remotes same as

$ git config --global --add

The default host for commands like init and clone is still, but this can be affected with the GITHUB_HOST environment variable:

$ git clone myproject


Prior art

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


The Go Gopher

There is no documentation for this package.

Source Files


Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL