Skip to content
A command-line tool that makes git easier to use with GitHub.
Go Gherkin Shell Ruby Makefile Batchfile Other
Branch: master
Clone or download

Latest commit

mislav Merge pull request #2502 from torkelrogstad/master
Add more Fish completions to pull-request
1
Latest commit 2cff4c2 Mar 16, 2020

Files

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
.github Remove support for Go < 1.11 Mar 5, 2020
cmd [cmd] Stop the surprising behavior of shell-splitting in `cmd.New()` Jun 28, 2019
commands Remove obsolete auto-updater file Mar 5, 2020
coverage Measure code coverage between tests Jun 7, 2018
etc Add more Fish completions to pull-request Mar 16, 2020
features Merge pull request #2432 from jfahrer/master Jan 21, 2020
fixtures Added type assertion test to YAML config decoder Dec 4, 2019
git Use `git symbolic-ref` to read the branch name for HEAD Mar 1, 2020
github Normalize `url.Error` message for Go 1.14 Mar 5, 2020
md2roff-bin [md2roff] Make man pages parseable with `whatis` Feb 18, 2019
md2roff Merge remote-tracking branch 'origin/master' into man-apostrophes Nov 14, 2019
script Merge branch 'patch-1' Mar 9, 2020
share [docs] Clarify HUB_VERBOSE Dec 30, 2019
ui Simplify code Jul 23, 2019
utils Inline check for updating flags Jan 20, 2020
vendor [http] Support HTTPS_PROXY, NO_PROXY from environment Oct 2, 2019
version hub 2.14.2 Mar 5, 2020
.dockerignore [test] Add ability to run tests in a Docker container Oct 29, 2019
.gitattributes Enforce unix eol in bash script files Sep 2, 2017
.gitignore [help] Enable `hub help --web <command>` Oct 31, 2019
CODE_OF_CONDUCT.md Improve contact email, part 2 Aug 28, 2017
CONTRIBUTING.md [docs] Improve CONTRIBUTING documentation Oct 29, 2019
Dockerfile [test] Add ability to run tests in a Docker container Oct 29, 2019
Gemfile Update Aruba to 1.0.0 prerelease Aug 21, 2019
Gemfile.lock Update Aruba to 1.0.0 prerelease Aug 21, 2019
LICENSE MIT Dec 8, 2009
Makefile Remove support for Go < 1.11 Mar 5, 2020
README.md Add openSUSE and zypper to install instructions Mar 12, 2020
cucumber.yml Update Cucumber Aug 21, 2019
go.mod Merge pull request #2286 from github/proxy-from-env Oct 10, 2019
go.sum [http] Support HTTPS_PROXY, NO_PROXY from environment Oct 2, 2019
main.go Remove unused `ogier/pflag` Jan 18, 2019
man-template.html Remove unwanted tracking from distributed HTML man pages Jan 21, 2020

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
#=> git clone git://github.com/rtomayko/tilt.git

# if you prefer HTTPS to git/SSH protocols:
$ git config --global hub.protocol https
$ hub clone rtomayko/tilt
#=> git clone https://github.com/rtomayko/tilt.git

See usage examples or the full reference documentation to see all available commands and flags.

hub can also be used to make shell scripts that directly interact with the GitHub API.

hub can be safely aliased as git, so you can type $ git <command> in the shell and have it expanded with hub features.

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.

platform manager command to run
macOS, Linux Homebrew brew install hub
Windows Scoop scoop install hub
Windows Chocolatey choco install hub
Fedora Linux DNF sudo dnf install hub
Arch Linux pacman sudo pacman -S hub
FreeBSD pkg(8) pkg install hub
Debian apt(8) sudo apt install hub
Ubuntu Snap sudo snap install hub --classic
openSUSE Zypper sudo zypper install hub

Packages other than Homebrew are community-maintained (thank you!) and they are not guaranteed to match the latest hub release. Check hub version after installing a community package.

Standalone

hub can be easily installed as an executable. Download the latest binary for your system and put it anywhere in your executable path.

GitHub Actions

hub can be used for automation through GitHub Actions workflows:

steps:
- uses: actions/checkout@v2

- name: hub example
  shell: bash
  run: |
    curl -fsSL https://github.com/github/hub/raw/master/script/get | bash -s 2.14.1
    bin/hub pr list  # list pull requests in the current repo
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Note that the default GITHUB_TOKEN will only work for API operations within the same repo that runs this workflow. If you need to access or write to other repositories, generate a Personal Access Token with repo scope and add it to your repository secrets.

Source

Prerequisites for building from source are:

Clone this repository and run make install:

git clone \
  --config transfer.fsckobjects=false \
  --config receive.fsckobjects=false \
  --config fetch.fsckobjects=false \
  https://github.com/github/hub.git

cd hub
make install prefix=/usr/local

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.

Meta

You can’t perform that action at this time.