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

Joe Block 7b800bcbc0 Switch to prepending ourself to `$PATH`		2016-07-11 16:44:10 -07:00
git-open	It works with both types of URL now	2016-07-08 18:44:35 +02:00
git-open.plugin.zsh	Switch to prepending ourself to `$PATH`	2016-07-11 16:44:10 -07:00
package.json	Add git-home as an alias for git-open	2015-09-10 12:12:31 -04:00
README.md	Make installable as a ZSH plugin by o-m-z compatible ZSH frameworks	2016-07-11 13:45:43 -07:00

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

Without using a framework

npm install --global git-open

Using a ZSH Framework

Antigen

Add antigen bundle paulirish/git-open to your .zshrc with your other bundle commands.

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

Oh-My-Zsh

cd ~/.oh-my-zsh/custom/plugins
git clone git@github.com:paulirish/git-open.git gitopen
Add git-open to your plugin list - edit ~.zshrc and change plugins=(...) to plugins=(... gitopen)

Zgen

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

Supported:

Github.com
Gists on Github
Bitbucket
Atlassian Stash
Gitlab.com
Gitlab custom hosted (see below)

Gitlab support

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

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

Thx

@jasonmccreary did all the hard work

License

http://opensource.org/licenses/MIT

README.md