A git sub-command to view your git repository in the web browser

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

sgoudham 3335011f6d refactor!: remove `--suffix` & revamp help BREAKING-CHANGE: I couldn't decide on the semantics of what this command should have so, instead, I've opted to remove it.		1 year ago
.github	build: overhaul ci/cd pipelines	1 year ago
.vscode	refactor: simplify docs and tidy up	1 year ago
src	refactor!: remove `--suffix` & revamp help	1 year ago
.gitignore	chore: Unignore Cargo.lock	2 years ago
CONTRIBUTING.md	docs: simplify wording	1 year ago
Cargo.lock	build: Update version number to v1.0.0	1 year ago
Cargo.toml	refactor!: remove `--suffix` & revamp help	1 year ago
LICENSE	Initial commit	3 years ago
README.md	refactor!: remove `--suffix` & revamp help	1 year ago
flake.lock	feat: add nix flake	1 year ago
flake.nix	feat: add nix flake	1 year ago

README.md

git-view

A git sub-command to view your git repository on GitHub!

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!

Note:
You should always use git view -h instead of git 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

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
# Given branch 'TICKET-123' or some other variation
# 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/main.rs

$ git view --path
# Given working directory 'src/lib.rs'
# https://github.com/TRACKED_REMOTE_USER/REPO/tree/CURRENT_BRANCH/src/main.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             Don't open GitHub and print URL
    -h, --help              Print help information
    -V, --version           Print version information

Contributing

Please read the CONTRIBUTING.md before contributing!

License

MIT

Acknowledgement

The idea for this project came about from an existing project git-open