git open to open the repo website (GitHub, GitLab, Bitbucket) in your browser.
git open [remote-name] [branch-name]git open --issue
git open works with these hosted repo providers,
git open --issue currently only works with GitHub, Visual Studio Team Services and Team Foundation Server)
$ git open# opens$ git open someremote# opens$ git open someremote somebranch# opens$ git open --issue# If branches use naming convention of issues/#123,# opens
The preferred way of installation is to simply add the
somewhere into your path (e.g. add the directory to your
git-open into an existing included path like
Install via NPM:
npm install --global git-open
Save git-open anywhere, say as ~/Documents/Scripts/git-open.sh and define a function in your Powershell profile (see ~/Documents/WindowsPowerShell/profile.ps1) like this:
git-open script in any place accessible via your
%PATH% environment var.
antigen bundle paulirish/git-open to your
.zshrc with your other bundle
Antigen will handle cloning the plugin for you automatically the next time you
start zsh, and periodically checking for updates to the git repository. You can
also add the plugin to a running zsh with
antigen bundle paulirish/git-open
for testing before adding it to your
git clone https://github.com/paulirish/git-open.git $ZSH_CUSTOM/plugins/git-open
git-opento your plugin list - edit
zgen load paulirish/git-open to your .zshrc file in the same function
you're doing your other
zgen load calls in. ZGen will take care of cloning
the repository the next time you run
zgen save, and will also periodically
check for updates to the git repository.
zplug "paulirish/git-open", as:plugin
Supported remote repositories
git-open can automatically guess the corresponding repository page for remotes
(default looks for
origin) on the following hosts:
- GitLab custom hosted (see below)
- Atlassian Bitbucket Server (formerly Atlassian Stash)
- Visual Studio Team Services
- Team Foundation Server (on-premises)
- AWS Code Commit
See the man page for more information on how to configure
See hub for complete GitHub opening support.
It's the official GitHub project and provides
Homebrew has an alternate git-open that only works with GitHub but can open user profile pages, too.
@gerep has an alternate git-open that works with a few providers. Of note, it opens the default view for BitBucket instead of the source view.
And, of course, jasonmccreary's original gh from which this plugin was forked.
Contributing & Development
Please provide examples of the URLs you are parsing with each PR.
You can run
echo mode, which doesn't open your browser, but just prints the URL to stdout:
env BROWSER='echo' ./git-open
You'll need to install bats, the Bash automated testing system. It's also available as
brew install bats
git submodule update --init # pull in the assertion libraries# Run the test suite once:bats test # or `npm run unit`# Run it on every change with `entr`brew install entrnpm run watch
git recent- View your most recent git branches
diff-so-fancy- Making the output of
git diffso fancy
Copyright Jason McCreary & Paul Irish. Licensed under MIT. http://opensource.org/licenses/MIT
- 2017-12-01 - 2.0 shipped. Breaking change: Gitlab configuration handled differently.
- 2017-12-01 - Configuration for custom remote added
- 2017-11-30 - Support for VSTS Added
- 2017-10-31 -
- 2017-10-30 - Configuration for custom domains added
- 2017-10-30 - WSL support added
- 2017-06-16 - Introduced a test suite in BATS
- 2017-06-15 - Entire script rewritten and simplified by @dermagia
- 2016-07-23 - Readme: fix oh-my-zsh install instructions
- 2016-07-22 - 1.1.0 shipped. update and add linters for package.json, readme.
- 2016-07-11 - Readme formatting and installation instructions updated. Changelog started