Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sgoudham/git-view
A git sub-command to view your git repository on GitHub
https://github.com/sgoudham/git-view
browser crate git github hacktoberfest rust
Last synced: 2 months ago
JSON representation
A git sub-command to view your git repository on GitHub
- Host: GitHub
- URL: https://github.com/sgoudham/git-view
- Owner: sgoudham
- License: mit
- Created: 2022-06-06T13:26:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-01T07:34:50.000Z (over 1 year ago)
- Last Synced: 2024-10-14T23:07:42.786Z (3 months ago)
- Topics: browser, crate, git, github, hacktoberfest, rust
- Language: Rust
- Homepage: https://crates.io/crates/git-view
- Size: 707 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
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 use `git view -h` instead of `git view --help` as the manpage/html files are **NOT** included.
## Features
- [x] View Branches, Commits & Issues
- [x] Custom Remote
- [x] Custom Directory
## Installation
Binaries are available [here](https://github.com/sgoudham/git-view/releases/latest).
### Cargo
```shell
cargo install git-view
```
### Nix
```shell
nix run github:sgoudham/git-view
```
### Homebrew
```shell
brew tap sgoudham/tap
brew install git-view
```
## Usage
```shell
$ 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
```shell
git-view 1.0.0
Goudham Suresh
A git sub-command to view your git repository on GitHub
USAGE:
git-view [OPTIONS]
OPTIONS:
-r, --remote The remote to view on GitHub
[default: default remote]
-b, --branch The branch to view on GitHub
[default: current branch]
-i, --issue The GitHub issue number
[default: number from current branch]
-c, --commit The commit to view on GitHub
[default: current commit]
-p, --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](./CONTRIBUTING.md) before contributing!
## License
[MIT](LICENSE)
## Acknowledgement
The idea for this project came about from an existing project [git-open](https://github.com/paulirish/git-open/blob/master/git-open)