hub helps you win at git.
Go Cucumber Shell Ruby Other
Latest commit d400838 Dec 5, 2016 @mislav mislav Remove obsolete self-updating functionality
We might bring back the self-updater at some point, but right now it's
dead code and it's not clear to me how to implement it in a fashion
where it also updates dependent files such as shell completion scripts
and man pages.
Permalink
Failed to load latest commit information.
cmd Ensure that "command not found" error is printed on stderr Oct 3, 2016
commands Remove obsolete self-updating functionality Dec 5, 2016
etc bashcomp: try to load git comp first (fix #592) Mar 5, 2016
features Fix issue/PR template lookup when in a subdirectory Nov 21, 2016
fixtures Add template tests May 30, 2016
git Do not expand aliases which are in-built git and hub commands Nov 7, 2016
github Remove obsolete self-updating functionality Dec 5, 2016
script don't copy .txt files to man path Oct 17, 2016
share/man/man1 New `hub sync` command to update local branches Sep 12, 2016
ui Use formatter when listing issues. May 11, 2016
utils Add relative date format to `issue` output Aug 16, 2016
vendor Remove obsolete self-updating functionality Dec 5, 2016
version hub 2.3.0-pre8 Oct 3, 2016
.agignore Add ctags configuration, `.agignore` file Sep 13, 2016
.ctags Add ctags configuration, `.agignore` file Sep 13, 2016
.gitignore Add ctags configuration, `.agignore` file Sep 13, 2016
.travis.yml Simplify Travis config and fix release process Aug 21, 2016
CONTRIBUTING.md Add `make install` Oct 3, 2016
Gemfile Include all man pages in packaged releases Jan 25, 2016
Gemfile.lock Delete hub examples and configuration docs from the README Jan 24, 2016
LICENSE MIT Dec 8, 2009
Makefile Add `make install` Oct 3, 2016
README.md Fix typo Oct 17, 2016
Vagrantfile Use Go 1.4.2 Apr 12, 2015
cucumber.yml Detect tmux and run shell completion tests Nov 14, 2013
main.go Show error to stderr if shelling out failed Sep 10, 2016

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:

$ git clone https://github.com/github/hub.git
$ cd hub
$ make install prefix=/usr/local

Prerequisites for compilation are:

  • make
  • Go 1.6+
  • Ruby 1.9+ with Bundler - for generating man pages

If you don't have make, Ruby, or want to skip man pages (for example, if you are on Windows), you can build only the hub binary:

$ ./script/build

You can now move bin/hub to somewhere in your PATH.

Finally, if you've done Go development before and your $GOPATH/bin directory is already in your PATH, this is an alternative installation method that fetches hub into your GOPATH and builds it automatically:

$ go get github.com/github/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: