Skip to content
A command-line tool that makes git easier to use with GitHub.
Branch: master
Clone or download
Latest commit 2cf4d7b Jul 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ctags.d Rename `ctags` file for compatibility with universal-ctags Jun 6, 2018
cmd [cmd] Stop the surprising behavior of shell-splitting in `cmd.New()` Jun 28, 2019
commands [help] Enable `man` appearing in path that has spaces Jun 28, 2019
coverage Measure code coverage between tests Jun 7, 2018
etc [docs] Don't assume that Homebrew is always on macOS Mar 12, 2019
features [auth] Allow hub used in Actions by specifying GITHUB_USER Jul 19, 2019
fixtures Preserve order of hosts in hub config file Jan 2, 2019
git Only process stdout when shelling out to git May 8, 2019
github [auth] Allow hub used in Actions by specifying GITHUB_USER Jul 19, 2019
md2roff-bin [md2roff] Make man pages parseable with `whatis` Feb 18, 2019
md2roff Compatibility with Go < 1.12 Apr 13, 2019
script build: pass mod vendoring flag on newer versions of go Jun 16, 2019
share [api] Add extended documentation for hub-api(1) Jan 24, 2019
ui ui Printf functions: handle errors by dying Dec 22, 2018
utils [env] Enable quoted values with spaces in $BROWSER Jun 28, 2019
vendor Update x/sys module to support Risc-V May 31, 2019
version hub 2.12.3 Jul 19, 2019
.gitattributes Enforce unix eol in bash script files Sep 2, 2017
.gitignore Ignore VSCode Jun 4, 2019
.travis.yml migrate to go modules from dep May 15, 2019
CODE_OF_CONDUCT.md Improve contact email, part 2 Aug 28, 2017
CONTRIBUTING.md migrate to go modules from dep May 15, 2019
Gemfile Remove Ruby ronn from build toolchain Dec 29, 2018
Gemfile.lock Remove Ruby ronn from build toolchain Dec 29, 2018
LICENSE MIT Dec 8, 2009
Makefile build: unexport GOPATH when module vendoring is used Jun 17, 2019
README.md Added Chocolatey as Windows install method in the readme Apr 23, 2019
Vagrantfile Use Go 1.4.2 Apr 12, 2015
cucumber.yml Detect tmux and run shell completion tests Nov 14, 2013
go.mod Update x/sys module to support Risc-V May 31, 2019
go.sum Update x/sys module to support Risc-V May 31, 2019
main.go Remove unused `ogier/pflag` Jan 18, 2019
man-template.html [md2roff] Style the "SYNOPSIS" section of HTML man pages Feb 18, 2019

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

or alternatively hub can be installed through Chocolatey:

> choco 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

You can’t perform that action at this time.