Skip to content
hub helps you win at git. http://hub.github.com/
Go Cucumber Shell Ruby Other
Latest commit f412a35 @mislav mislav Merge pull request #1095 from github/release-overhaul
Big overhaul of `hub release` command
Failed to load latest commit information.
cmd Improve detecting local clone resources
commands Merge pull request #1095 from github/release-overhaul
etc Add bash + homebrew section and bash_profile mention
features Merge pull request #1095 from github/release-overhaul
fixtures Add unit tests for git.Remotes() and github.Remotes().
git go fmt
github Encapsulate similarities between making requests within simpleApi
man List hub commands in main man page
script Implement `script/github-release` with bash + `hub release`
ui Switch from godep & rewriting import paths to GO15VENDOREXPERIMENT
utils Change `hub help` to display man pages when available
vendor Switch from `user.Current()` to mitchellh/go-homedir
version Add hub version to crash report
.gitignore Makefile galore!
.travis.yml Makefile galore!
CONTRIBUTING.md Makefile galore!
Gemfile Include all man pages in packaged releases
Gemfile.lock Delete hub examples and configuration docs from the README
LICENSE MIT
Makefile Add `hub release show <TAG>`
README.md Remove outdated `go get` installation instructions
Vagrantfile Use Go 1.4.2
cucumber.yml Detect tmux and run shell completion tests
main.go Change namespace to github/hub

README.md

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://github.com/rtomayko/tilt.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.

Installation

Dependencies:

  • git 1.7.3 or newer

Homebrew

hub can be installed through Homebrew:

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

Standalone

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

Source

To install hub from source, you need to have a Go development environment:

$ git clone https://github.com/github/hub.git
$ cd hub
# Assuming `~/bin` is in your PATH:
$ ./script/build -o ~/bin/hub

Aliasing

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

Meta

Prior art

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

Something went wrong with that request. Please try again.