Github url

hub

by github

github /hub

A command-line tool that makes git easier to use with GitHub.

20.1K Stars 2.1K Forks Last release: 5 months ago (v2.14.2) MIT License 3.3K Commits 101 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

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.

For an official, potentially more user-friendly command-line interface to GitHub, see cli.github.com andthis comparison.

This repository and its issue tracker is not for reporting problems with GitHub.com web interface. If you have a problem with GitHub itself, pleasecontact 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></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 | We do not recommend installing the snap anymore.openSUSE | Zypper |

sudo zypper install hub

Void Linux | xbps |

sudo xbps-install -S hub

Gentoo | Portage |

sudo emerge dev-vcs/hub

any | conda |

conda install -c conda-forge 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 is ready to be used in your GitHub Actions workflows: ```yaml steps: - uses: actions/[email protected]

  • name: List open pull requests run: hub pr list env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ```

Note that the default

secrets.GITHUB\_TOKEN

will only work for API operations scoped to the repository that runs this workflow. If you need to interact with other repositories, generate a Personal Access Token with at least the

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.