2 releases (1 stable)
1.0.0 | Jul 4, 2023 |
---|---|
0.1.0 | Jun 26, 2022 |
#2944 in Command line utilities
52KB
1K
SLoC
git-view ( )
About
Are you also frustrated from moving your hands away from the keyboard to view your git repository on GitHub?
Me too!!!
git-view
alleviates that pain by allowing you to chuck away your mouse and instead open it via the CLI!
Note
You should always usegit view -h
instead ofgit view --help
as the manpage/html files are NOT included.
Features
- View Branches, Commits & Issues
- Custom Remote
- Custom Directory
Installation
Binaries are available here.
Cargo
cargo install git-view
Nix
nix run github:sgoudham/git-view
Homebrew
brew tap sgoudham/tap
brew install git-view
Usage
$ git view
# https://github.com/TRACKED_REMOTE_USER/REPO/tree/CURRENT_BRANCH
$ git view --remote remote
# https://github.com/PROVIDED_REMOTE_USER/REPO/tree/CURRENT_BRANCH
$ git view --remote remote --branch branch
# https://github.com/PROVIDED_REMOTE_USER/REPO/tree/PROVIDED_BRANCH
$ git view --issue
# Branch 'TICKET-123'
# https://github.com/TRACKED_REMOTE_USER/REPO/issues/123
$ git view --issue 42
# https://github.com/TRACKED_REMOTE_USER/REPO/issues/42
$ git view --commit
# https://github.com/TRACKED_REMOTE_USER/REPO/tree/CURRENT_COMMIT
$ git view --commit efa38be50ad34d
# https://github.com/TRACKED_REMOTE_USER/REPO/tree/efa38be50ad34d
$ git view --commit efa38be50ad34d --path src/lib.rs
# https://github.com/TRACKED_REMOTE_USER/REPO/tree/efa38be50ad34d/src/lib.rs
$ git view --path
# Working Directory 'src/lib.rs'
# https://github.com/TRACKED_REMOTE_USER/REPO/tree/CURRENT_BRANCH/src/lib.rs
$ git view --path CONTRIBUTING.md
# https://github.com/TRACKED_REMOTE_USER/REPO/tree/CURRENT_BRANCH/CONTRIBUTING.md
$ git view --path CONTRIBUTING.md --branch testing
# https://github.com/TRACKED_REMOTE_USER/REPO/tree/PROVIDED_BRANCH/CONTRIBUTING.md
$ git view --print
# prints https://github.com/TRACKED_REMOTE_USER/REPO/tree/CURRENT_BRANCH
Help
git-view 1.0.0
Goudham Suresh <sgoudham@gmail.com>
A git sub-command to view your git repository on GitHub
USAGE:
git-view [OPTIONS]
OPTIONS:
-r, --remote <name> The remote to view on GitHub
[default: default remote]
-b, --branch <name> The branch to view on GitHub
[default: current branch]
-i, --issue <number> The GitHub issue number
[default: number from current branch]
-c, --commit <hash> The commit to view on GitHub
[default: current commit]
-p, --path <path> The directory/file to view on GitHub
[default: current working directory]
--print Print URL instead of opening on GitHub
-h, --help Print help information
-V, --version Print version information
Contributing
Please read the CONTRIBUTING.md before contributing!
License
Acknowledgement
The idea for this project came about from an existing project git-open
Dependencies
~3–11MB
~128K SLoC