Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/albertyw/git-browse
Open git files, directories, hashes, tags, and branches in the browser
https://github.com/albertyw/git-browse
bitbucket browser git git-browse github gitlab hacktoberfest phabricator python-3 sourcegraph version-control
Last synced: 12 days ago
JSON representation
Open git files, directories, hashes, tags, and branches in the browser
- Host: GitHub
- URL: https://github.com/albertyw/git-browse
- Owner: albertyw
- License: mit
- Created: 2017-01-08T08:31:17.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-13T05:14:07.000Z (4 months ago)
- Last Synced: 2024-10-12T05:14:17.185Z (26 days ago)
- Topics: bitbucket, browser, git, git-browse, github, gitlab, hacktoberfest, phabricator, python-3, sourcegraph, version-control
- Language: Python
- Homepage:
- Size: 232 KB
- Stars: 26
- Watchers: 5
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Git Browse
==========
[](https://pypi.org/project/git-browse/)
[](https://drone.albertyw.com/albertyw/git-browse)
[](https://codeclimate.com/github/albertyw/git-browse)
[](https://codeclimate.com/github/albertyw/git-browse/coverage)
Open git repositories, commits, directories, and files in the browser. See also,
[git-reviewers](https://github.com/albertyw/git-reviewer).
This script can be added as a gitconfig alias to easily browse
repositories on Git hosting services (e.g. github). It is built to model
[arcanist's browse](https://github.com/phacility/arcanist/blob/master/src/workflow/ArcanistBrowseWorkflow.php)
command. It is specifically designed to have no
dependencies so it should be easily installable and very portable.
Git Browse supports opening git repositories, commits, directories, and files:
- [Bitbucket](https://bitbucket.org/)
- [Github](https://github.com/)
- [Gitlab](https://gitlab.com/)
- [GoDocs](https://godocs.io/)
- [Phabricator](https://www.phacility.com/phabricator/)
- [Sourcegraph](https://about.sourcegraph.com/)
Installation
------------
### HomeBrew (preferred for MacOS)
If you use Homebrew, you can install git-browse through the
[homebrew-albertyw tap](https://github.com/albertyw/homebrew-albertyw>):
```bash
brew install albertyw/albertyw/git-browse
```
### Manual
If you don't use Homebrew, first clone this repository to somewhere on
your system (perhaps in your [dotfiles](https://github.com/albertyw/dotfiles) repository), then run
`/install.sh`.
Usage
-----
```
$ git browse -h
'browse' is aliased to '!~/.dotfiles/scripts/git/git-browse/git_browse/browse.py --path=${GIT_PREFIX:-./}'
usage: browse.py [-h] [--path PATH] [-d] [-c] [-s] [-g] [-v] [target]
Open repositories, directories, and files in the browser. https://github.com/albertyw/git-browse
positional arguments:
target file, directory, git hash, or git branch you wish to browse
optional arguments:
-h, --help show this help message and exit
--path PATH relative path to the current git repository
-d, --dry-run Do not open the url in the brower, and only print to stdout
-c, --copy Copy url to clipboard, if available
-s, --sourcegraph Open objects in sourcegraph
-g, --godocs Open objects in godocs
-v, --version show program's version number and exit
```
### Examples
| Command | Opens |
|-----------------------------------|------------------------------------------------------------------------------------------|
| `git browse` | |
| `git browse README.md` | |
| `git browse git_browse` | |
| `git browse v1.1.1` | |
| `git browse --sourcegraph` |
| `git browse --godocs` |
| `git browse` for Bitbucket |
| `git browse` for Gitlab |
| `git browse` for Uber Phabricator |
Related Projects
----------------
- [git-brws](https://github.com/rhysd/git-brws)
- [hub browse](https://hub.github.com/)
- [git open](https://github.com/paulirish/git-open)
- [open-browser-github.vim](https://github.com/tyru/open-browser-github.vim)
Development
-----------
```bash
pip install -e .[test]
ruff check .
mypy .
coverage run -m unittest
coverage report
```
Publishing
----------
1. Update changelog and `__version__` variable with a semantic version
2. Commit changes, create a version tag, and push both
3. Update [albertyw/homebrew-albertyw](https://github.com/albertyw/homebrew-albertyw)