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

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

Mislav Marohnić 3a69a3ba78 Avoid crashing in `pull-request` error processing When `api.PostJSON()` returns an error because of invalid JSON or a network error, `res` variable will be nil. Avoid reading from nil `res`. Fixes #1253, fixes #1251, fixes #1248, fixes #1244		2016-09-08 18:22:25 +02:00
cmd	…
commands	Fix `release` from detached HEAD	2016-08-21 18:10:31 +02:00
etc	…
features	Fix `release` from detached HEAD	2016-08-21 18:10:31 +02:00
fixtures	…
git	…
github	Avoid crashing in `pull-request` error processing	2016-09-08 18:22:25 +02:00
script	Simplify Travis config and fix release process	2016-08-21 15:57:31 +02:00
share/man/man1	Advertise hub-issue(1) and hub-release(1) in man pages	2016-08-21 14:20:10 +02:00
ui	…
utils	…
vendor	…
version	hub 2.3.0-pre3	2016-08-21 18:12:27 +02:00
.gitignore	…
.travis.yml	Simplify Travis config and fix release process	2016-08-21 15:57:31 +02:00
CONTRIBUTING.md	…
Gemfile	…
Gemfile.lock	…
LICENSE	…
Makefile	Advertise hub-issue(1) and hub-release(1) in man pages	2016-08-21 14:20:10 +02:00
README.md	…
Vagrantfile	…
cucumber.yml	…
main.go	…

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:

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:

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

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

$ go get github.com/github/hub

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)"

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