mirror of https://github.com/paulirish/git-open.git synced 2026-09-10 07:26:15 -04:00

Author: "Type git open to open the repo website (GitHub, GitLab, Bitbucket) in your browser."

Go to file

David O'Trakoun 579cd7cc89 readme additions and formatting		2016-07-11 19:25:06 -04:00
git-open	It works with both types of URL now	2016-07-08 18:44:35 +02:00
package.json	Add git-home as an alias for git-open	2015-09-10 12:12:31 -04:00
README.md	readme additions and formatting	2016-07-11 19:25:06 -04:00

README.md

git-open

Type git open to open the GitHub page or website for a repository in your browser.

Usage

git open [remote-name] [branch-name]

Examples

$ git open
> open https://github.com/REMOTE_ORIGIN_USER/CURRENT_REPO/tree/CURRENT_BRANCH

$ git open upstream
> open https://github.com/REMOTE_UPSTREAM_USER/CURRENT_REPO/tree/CURRENT_BRANCH

$ git open upstream master
> open https://github.com/REMOTE_UPSTREAM_USER/CURRENT_REPO/tree/master

Installation

npm install --global git-open

Supported hosts

<github.com>
<gist.github.com>
<gitlab.com>
Gitlab custom hosted (see below)
<bitbucket.org>
Atlassian Stash

Gitlab support

To configure gitlab support you need to set gitopen.gitlab.domain

git config --global gitopen.gitlab.domain [yourdomain.here]

git config gitopen.gitlab.domain [yourdomain.here] # in your local repository

See hub for complete GitHub opening support. It's the official GitHub project and provides hub browse.

Thanks

jasonmccreary did all the hard work

See the contributors tab for a growing list of people who have submitted PRs.

Contributing

Please provide examples of the URLs you are parsing with each PR.