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

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

Mislav Marohnić d1cb6d7d12 Simplify Travis config and fix release process		2016-08-21 15:57:31 +02:00
cmd	Improve detecting local clone resources	2016-01-22 20:47:51 +11:00
commands	Clean up display of available `--format` flags	2016-08-21 14:20:10 +02:00
etc	bashcomp: try to load git comp first (fix #592 )	2016-03-04 19:18:25 -07:00
features	Cleanup in cukes	2016-08-21 13:23:26 +02:00
fixtures	Add template tests	2016-05-30 12:49:53 -07:00
git	Expand environment variables in GIT_EDITOR value	2016-08-07 23:55:56 +02:00
github	Tweak whitespace in issue/PR template handling	2016-08-21 11:22:57 +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	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	Update gopass dependency for cross-platform compatibility	2016-08-14 23:01:51 +02:00
version	hub 2.3.0-pre1	2016-08-21 14:37:11 +02:00
.gitignore	Move man pages to `share/man/man1/`	2016-08-21 14:20:10 +02:00
.travis.yml	Simplify Travis config and fix release process	2016-08-21 15:57:31 +02:00
CONTRIBUTING.md	It's Go 1.6 now	2016-08-15 12:21:24 +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	…
Makefile	Advertise hub-issue(1) and hub-release(1) in man pages	2016-08-21 14:20:10 +02:00
README.md	It's Go 1.6 now	2016-08-15 12:21:24 +02:00
Vagrantfile	Use Go 1.4.2	2015-04-12 13:57:05 -07:00
cucumber.yml	…
main.go	Change namespace to github/hub	2014-02-10 08:29:03 -08: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, 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

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