A command-line tool that makes git easier to use with GitHub.
Перейти к файлу
Ahmet Alp Balkan 2c9de69120
pull-request: Hide Signed-off-by
Fixes #1724.

This patch omits the "Signed-off-by:" line coming from pull requests created
out of single commit messages. This way the user does not need to manually
remove their email address from the PR description.

Not introducing a flag for this as it applies to only one case (single-commit
diff between heads, as well as no -m/-f/-i specified).

Meta: sending this PR with the patched build, my Signed-off-by line is removed
automatically from the PR message.

Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
2018-05-28 11:04:16 -07:00
cmd pass file descriptors to cmd.NewWithArray 2017-08-04 18:16:16 -05:00
commands pull-request: Hide Signed-off-by 2018-05-28 11:04:16 -07:00
etc Add milestone to pr by name instead of number 2018-03-16 00:28:06 +01:00
features Allow user to provide a token instead of a password 2018-05-18 14:49:51 +02:00
fixtures Add template tests 2016-05-30 12:49:53 -07:00
git No commit signature in default pull request message 2018-01-29 22:40:36 +01:00
github Allow user to provide a token instead of a password 2018-05-18 14:49:51 +02:00
script Avoid `dep` clashing with Bundler 2018-01-29 20:59:23 +01:00
share/man/man1 Document available environment variables 2017-09-06 16:35:54 +02:00
ui spelling: indicate 2017-11-08 02:38:45 +00:00
utils Add relative date format to `issue` output 2016-08-16 17:29:41 +02:00
vendor Remove octokit dependency 2018-01-29 20:59:23 +01:00
version hub 2.3.0-pre10 2017-06-26 20:23:46 +02:00
.agignore Ignore `bundle/` directory when searching 2018-02-21 13:40:34 +01:00
.ctags Ignore `bundle/` directory when searching 2018-02-21 13:40:34 +01:00
.gitattributes Enforce unix eol in bash script files 2017-09-02 20:55:54 +01:00
.gitignore Avoid `dep` clashing with Bundler 2018-01-29 20:59:23 +01:00
.travis.yml travis: update go versions 2017-09-20 07:56:28 +02:00
CODE_OF_CONDUCT.md Improve contact email, part 2 2017-08-28 21:47:08 +02:00
CONTRIBUTING.md CONTRIBUTING: note license. 2018-02-16 09:09:22 +00: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
Gopkg.lock Remove octokit dependency 2018-01-29 20:59:23 +01:00
Gopkg.toml Remove octokit dependency 2018-01-29 20:59:23 +01:00
LICENSE MIT 2009-12-08 02:13:06 -08:00
Makefile Simplify `make clean` 2017-05-17 13:03:06 +02:00
README.md README.md (#1694) 2018-03-12 12:19:33 +01: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 Enforce go1.8+ via build flags too 2017-05-17 13:34:13 +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 on macOS:

$ brew install hub
$ hub version
git version 1.7.6
hub version 2.2.3

If you want to get access to new hub features earlier and help with its development by reporting bugs, you can install the prerelease version:

$ brew install --devel hub

Windows

hub can be installed through Chocolatey or Scoop on Windows:

> choco install hub
# or:
> scoop install hub

Fedora Linux

On Fedora you can install hub through DNF:

$ sudo dnf install hub
$ hub version
git version 2.9.3
hub version 2.2.9

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.8+
  • 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)"

PowerShell

If you're using PowerShell, you can set an alias for hub by placing the following in your PowerShell profile (usually ~/Documents/WindowsPowerShell/Microsoft.PowerShell_profile.ps1):

Set-Alias git hub

A simple way to do this is to run the following from the PowerShell prompt:

Add-Content $PROFILE "`nSet-Alias git hub"

Note: You'll need to restart your PowerShell console in order for the changes to be picked up.

If your PowerShell profile doesn't exist, you can create it by running the following:

New-Item -Type file -Force $PROFILE

Shell tab-completion

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

Installation instructions

Meta