A command-line tool that makes git easier to use with GitHub.

Перейти к файлу

Mislav Marohnić 5b76f1ad76 Touch up docs for shell completion scripts		2017-02-06 15:24:38 +01:00
cmd	Ensure that "command not found" error is printed on stderr	2016-10-03 19:12:05 +02:00
commands	Preserve description	2017-01-26 00:49:09 +09:00
etc	Touch up docs for shell completion scripts	2017-02-06 15:24:38 +01:00
features	Add automated tests for fish completion	2017-02-06 15:20:17 +01:00
fixtures	Add template tests	2016-05-30 12:49:53 -07:00
git	Do not expand aliases which are in-built git and hub commands	2016-11-07 14:30:45 +01:00
github	Remove obsolete self-updating functionality	2016-12-05 22:07:31 +01:00
script	Skip completion tests on Travis new Docker setup	2016-12-08 15:01:59 +01:00
share/man/man1	New `hub sync` command to update local branches	2016-09-12 06:29:53 +02:00
ui	Use formatter when listing issues.	2016-05-11 14:39:46 +02:00
utils	Add relative date format to `issue` output	2016-08-16 17:29:41 +02:00
vendor	Remove obsolete self-updating functionality	2016-12-05 22:07:31 +01:00
version	hub 2.3.0-pre8	2016-10-03 20:38:25 +02:00
.agignore	Add ctags configuration, `.agignore` file	2016-09-13 14:25:14 +02:00
.ctags	Add ctags configuration, `.agignore` file	2016-09-13 14:25:14 +02:00
.gitignore	Add ctags configuration, `.agignore` file	2016-09-13 14:25:14 +02:00
.travis.yml	Simplify Travis config and fix release process	2016-08-21 15:57:31 +02:00
CONTRIBUTING.md	Add `make install`	2016-10-03 20:32:39 +02:00
Gemfile	Include all man pages in packaged releases	2016-01-25 22:49:38 +11:00
Gemfile.lock	Delete hub examples and configuration docs from the README	2016-01-25 02:30:47 +11:00
LICENSE	MIT	2009-12-08 02:13:06 -08:00
Makefile	Add `make install`	2016-10-03 20:32:39 +02:00
README.md	Update README	2017-01-23 22:50:18 +09:00
Vagrantfile	Use Go 1.4.2	2015-04-12 13:57:05 -07:00
cucumber.yml	Detect tmux and run shell completion tests	2013-11-14 16:05:56 +01:00
main.go	Show error to stderr if shelling out failed	2016-09-10 23:08:48 +02:00

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