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

Joe Block 6a64e8b563 Make spacing after header lines consistent

There were a couple of headers that didn't have a blank line after them,
made them consistent with the others.

2016-07-12 14:15:21 -05:00

3.4 KiB

Raw Blame History

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

The preferred way of installation is to simply add the git-open script somewhere into your path (e.g. add the directory to your PATH environment or copy git-open into an existing included path like /usr/local/bin).

You can use also npm to install an OLD (1 year ago) version of this package:

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.

zplug

zplug "paulirish/git-open", as:command

Supported remote repositories

git-open can automatically guess the corresponding repository page for remotes (default looks for origin) on the following hosts:

github.com
gist.github.com
gitlab.com
Gitlab custom hosted (see below)
bitbucket.org
Atlassian Bitbucket Server (formerly Atlassian Stash)

Gitlab support

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

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

or in your local repository:

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

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

Homebrew has an alternate git-open that only works with GitHub but can open user profile pages, too.

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.

License

Changelog

2016-07-11 - Changelog started (readme formatting and installation instructions updated)

3.4 KiB Raw Blame History