A command-line tool that makes git easier to use with GitHub.
Перейти к файлу
Matthieu Antoine b207e80358 Implement opening draft pull requests
Implement draft by adding a -d / --draft argument. Add setting header on
the API client for the moment as the feature is still in preview on the API
2019-03-29 01:18:03 +01:00
.ctags.d Rename `ctags` file for compatibility with universal-ctags 2018-06-06 14:00:17 +02:00
cmd Fix subcommand execution under WSL 2019-01-28 01:37:20 +01:00
commands Implement opening draft pull requests 2019-03-29 01:18:03 +01:00
coverage Measure code coverage between tests 2018-06-07 14:44:56 +02:00
etc [docs] Don't assume that Homebrew is always on macOS 2019-03-12 15:09:27 +01:00
features Merge pull request #2096 from github/no-command 2019-03-29 01:12:18 +01:00
fixtures Preserve order of hosts in hub config file 2019-01-02 18:27:50 +01:00
git Support git versions that don't recognize --no-verbose 2018-12-11 10:30:24 +00:00
github Implement opening draft pull requests 2019-03-29 01:18:03 +01:00
md2roff [md2roff] Make man pages parseable with `whatis` 2019-02-18 13:01:05 +01:00
md2roff-bin [md2roff] Make man pages parseable with `whatis` 2019-02-18 13:01:05 +01:00
script [ci] Fix uploading binaries to an existing release 2019-01-26 18:21:01 +01:00
share [api] Add extended documentation for hub-api(1) 2019-01-24 20:05:26 +01:00
ui ui Printf functions: handle errors by dying 2018-12-22 12:30:38 -05:00
utils [cli] Have commands with rich output respect the `--color` flag 2019-02-18 14:21:25 +01:00
vendor Remove unused `ogier/pflag` 2019-01-18 04:16:46 +01:00
version hub 2.10.2 2019-03-29 01:12:55 +01:00
.gitattributes Enforce unix eol in bash script files 2017-09-02 20:55:54 +01:00
.gitignore Switch to new md2roff process in `make man-pages` 2018-12-29 14:33:12 +01:00
.travis.yml Stop testing against go 1.8 2019-01-18 04:32:44 +01:00
CODE_OF_CONDUCT.md Improve contact email, part 2 2017-08-28 21:47:08 +02:00
CONTRIBUTING.md Stop testing against go 1.8 2019-01-18 04:32:44 +01:00
Gemfile Remove Ruby ronn from build toolchain 2018-12-29 14:33:12 +01:00
Gemfile.lock Remove Ruby ronn from build toolchain 2018-12-29 14:33:12 +01:00
Gopkg.lock Remove unused `ogier/pflag` 2019-01-18 04:16:46 +01:00
Gopkg.toml Remove unused `ogier/pflag` 2019-01-18 04:16:46 +01:00
LICENSE MIT 2009-12-08 02:13:06 -08:00
Makefile Makefile: fix arguments to go, not matching what go expects 2019-01-27 04:15:43 -05:00
README.md [docs] Don't assume that Homebrew is always on macOS 2019-03-12 15:09:27 +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 Remove unused `ogier/pflag` 2019-01-18 04:16:46 +01:00
man-template.html [md2roff] Style the "SYNOPSIS" section of HTML man pages 2019-02-18 13:13:13 +01:00

README.md

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.

This repository and its issue tracker is not for reporting problems with GitHub.com web interface. If you have a problem with GitHub itself, please contact Support.

Usage

$ hub clone rtomayko/tilt

# expands to:
$ git clone git://github.com/rtomayko/tilt.git

hub can be safely aliased as git so you can type $ git <command> in the shell and get all the usual hub features.

See Usage documentation for the list of all commands and their arguments.

Hub can also be used to make shell scripts that manually interface with the GitHub API.

Installation

The hub executable has no dependencies, but since it was designed to wrap git, it's recommended to have at least git 1.7.3 or newer.

Homebrew

hub can be installed through Homebrew/Linuxbrew:

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

Windows

hub can be installed through Scoop on Windows:

> 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

Arch Linux

On Arch Linux you can install hub from the official repository:

$ sudo pacman -S hub

FreeBSD

On FreeBSD you can install a prebuilt hub package with pkg(8):

# pkg install hub

Debian

On Debian (versions sid and buster) you can install hub from the official repository:

$ sudo apt install hub

Standalone

hub can be easily installed as an executable. Download the latest compiled binaries and put it anywhere in your executable path.

Source

With your GOPATH already set up:

mkdir -p "$GOPATH"/src/github.com/github
git clone \
  --config transfer.fsckobjects=false \
  --config receive.fsckobjects=false \
  --config fetch.fsckobjects=false \
  https://github.com/github/hub.git "$GOPATH"/src/github.com/github/hub
cd "$GOPATH"/src/github.com/github/hub
make install prefix=/usr/local

Prerequisites for compilation are:

Aliasing

Some hub features feel 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