938396a69b
Closes #2366 |
||
|---|---|---|
| .ctags.d | ||
| .github | ||
| cmd | ||
| commands | ||
| coverage | ||
| etc | ||
| features | ||
| fixtures | ||
| git | ||
| github | ||
| md2roff | ||
| md2roff-bin | ||
| script | ||
| share | ||
| ui | ||
| utils | ||
| vendor | ||
| version | ||
| .dockerignore | ||
| .gitattributes | ||
| .gitignore | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| Gemfile | ||
| Gemfile.lock | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| cucumber.yml | ||
| go.mod | ||
| go.sum | ||
| main.go | ||
| man-template.html | ||
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.
| 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 | snap install hub --classic |
Standalone
hub can be easily installed as an executable. Download the latest
compiled binaries and put it anywhere
in your executable path.
Source
Prerequisites for building from source are:
make- Go 1.9+
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
This assumes support for Go 1.11+
modules. If you are building on an
older version of Go, you will need to clone the repository into
$GOPATH/src/github.com/github/hub.
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.