Go Gherkin Shell Ruby Other
Latest commit a45f457 Aug 15, 2017 @mislav mislav committed on GitHub Merge pull request #1537 from mareksuscak/document-brew-devel
Document the availability of the development version.
Permalink
Failed to load latest commit information.
cmd pass file descriptors to cmd.NewWithArray Aug 4, 2017
commands compare repos using sameAs not strcmp Aug 12, 2017
etc Touch up docs for shell completion scripts Feb 6, 2017
features Assert exact stdout for different `hub fork` scenarios Aug 15, 2017
fixtures Add template tests May 30, 2016
git Show hub version even if `git version` fails Jun 26, 2017
github fix windows build Jul 8, 2017
script Merge pull request #1470 from eljobe/fixes/tmpdir Jun 26, 2017
share/man/man1 New `hub sync` command to update local branches Sep 12, 2016
ui Use formatter when listing issues. May 11, 2016
utils Add relative date format to `issue` output Aug 16, 2016
vendor Remove obsolete self-updating functionality Dec 5, 2016
version hub 2.3.0-pre10 Jun 26, 2017
.agignore Add ctags configuration, `.agignore` file Sep 13, 2016
.ctags Add ctags configuration, `.agignore` file Sep 13, 2016
.gitignore .gitignore the hub binary Apr 8, 2017
.travis.yml Update Travis to use Go 1.8.1 May 11, 2017
CONTRIBUTING.md Merge pull request #1437 from christopher-hopper/patch-1 Jun 26, 2017
Gemfile Include all man pages in packaged releases Jan 25, 2016
Gemfile.lock Delete hub examples and configuration docs from the README Jan 24, 2016
LICENSE MIT Dec 8, 2009
Makefile Simplify `make clean` May 17, 2017
README.md Use a positive language. Aug 15, 2017
Vagrantfile Use Go 1.4.2 Apr 12, 2015
cucumber.yml Detect tmux and run shell completion tests Nov 14, 2013
main.go Enforce go1.8+ via build flags too May 17, 2017

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

Chocolatey

hub can be installed through Chocolatey on Windows.

> choco install hub
> hub version
git version 2.7.1.windows.2
hub version 2.2.3

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 and zsh. These scripts complement existing completion scripts that ship with git.

Installation instructions

Meta