utils-code/paulirish.git-open
1
0
Fork 0
mirror of https://github.com/paulirish/git-open.git synced 2026-09-10 07:26:15 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

readme additions and formatting

Browse source
This commit is contained in:
David O'Trakoun 2016-07-11 19:25:06 -04:00
parent 55a5b96a9f
commit 579cd7cc89
No known key found for this signature in database
GPG key ID: 10BABFF393314390
1 changed files with 35 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
README.md
View file

@ -1,13 +1,14 @@
# git-open
Type `git open` to open the GitHub page or website for a repository in your browser.
Type `git open` to open the GitHub page or website for a repository in your
browser.
## Usage
git open [remote-name] [branch-name]
![git open2015-01-24 13_51_18](https://cloud.githubusercontent.com/assets/39191/5889192/244a0b72-a3d0-11e4-8ab9-55fc64228aaa.gif)
### Examples
$ git open
> open https://github.com/REMOTE_ORIGIN_USER/CURRENT_REPO/tree/CURRENT_BRANCH
@ -17,39 +18,48 @@ Type `git open` to open the GitHub page or website for a repository in your brow
$ git open upstream master
> open https://github.com/REMOTE_UPSTREAM_USER/CURRENT_REPO/tree/master
![git open2015-01-24 13_51_18](https://cloud.githubusercontent.com/assets/39191/5889192/244a0b72-a3d0-11e4-8ab9-55fc64228aaa.gif)
## Installation
### Installation
npm install --global git-open
```sh
npm install --global git-open
```
### Supported hosts
#### Supported:
* Github.com
* Gists on Github
* Bitbucket
* Atlassian Stash
* Gitlab.com
* <github.com>
* <gist.github.com>
* <gitlab.com>
* Gitlab custom hosted (see below)
* <bitbucket.org>
* Atlassian Stash
#### Gitlab support
## Gitlab support
To configure gitlab support you need to set gitopen.gitlab.domain:
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
```
git config --global gitopen.gitlab.domain [yourdomain.here]
or
## Thx
@jasonmccreary did [all the hard work](https://github.com/jasonmccreary/gh)
git config gitopen.gitlab.domain [yourdomain.here] # in your local repository
## Related projects
See [hub](https://github.com/github/hub) for complete GitHub opening support.
It's the official GitHub project and provides `hub browse`.
## Thanks
[jasonmccreary](https://github.com/jasonmccreary/) did
[all the hard work](https://github.com/jasonmccreary/gh)
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
Copyright Jason McCreary & Paul Irish. Licensed under MIT.
Copyright Jason McCreary & Paul Irish. Licensed under MIT.
http://opensource.org/licenses/MIT