#git #browser #github #view #keyboard #web

bin+lib git-view

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

1 unstable release

Uses new Rust 2021

0.1.0 Jun 26, 2022

#393 in Hardware support

MIT license

165KB
1K SLoC

git-view

build crates.io downloads license

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

About

Are you also frustrated from moving your hands away from the keyboard to view your git repository in the browser?

Me too!

git-view alleviates that pain by allowing you to chuck away your mouse!

(n)vim users rejoice :P

Important Note: You should always use git view -h instead of git view --help as the manpage/html files are NOT included.

Features

  • GitHub & BitBucket
  • View Branches, Commits & Issues
  • Custom Suffix
  • Custom Remote
  • View Profile
  • View Current Directory

Feel free to raise any issues or pull requests (after having read the CONTRIBUTING.md!) for any additional features that you want!

Usage

Usage

Installation

Cargo

The preferred way of installation is to manually install the provided binaries and update your $PATH variable to enable the usage as git view globally. However, that being said, it also available on crates.io to allow installation through the use of Rust's build tool and package manager cargo.

If you do not have cargo available on your machine, you can download it here

$ cargo install git-view

Refresh terminal & verify installation

$ git view --version
git-view 0.1.0

Homebrew

For macOS users, installation through Homebrew is recommended.

$ brew tap sgoudham/tap
$ brew install git-view

Refresh terminal & verify installation

$ git view --version
git-view 0.1.0

Binaries

Pre-compiled binaries are always available with every single release for Windows, macOS and Linux.

The examples shown below will showcase the installation of the binaries living within the local git directory but realistically, any path will work if updated correctly within $PATH.

Windows

  1. Download either git-view-x86_64-pc-windows-msvc.zip or git-view-x86_64-pc-windows-gnu.zip

  2. Find local git directory

# CMD
$ where git
C:\Program Files\Git\cmd\git.exe

# PowerShell
$ (Get-Command git.exe).Path
C:\Program Files\Git\cmd\git.exe
  1. cd into above path & extract downloaded binary zip
$ cd 'C:\Program Files\Git\cmd'

$ tar -xf git-view-x86_64-pc-windows-msvc.zip
# OR
$ tar -xf git-view-x86_64-pc-windows-gnu.zip
  1. Ensure %PATH% is updated
# Only required if git-view exists within a path not already included within %PATH%
$ setx path "%path%;C:\your\path\here\bin"
  1. Refresh terminal and verify installation
$ git view --version
git-view 0.1.0

Linux / macOS

  1. Download git-view-x86_64-unknown-linux-gnu.tar.gz or git-view-x86_64-unknown-linux-musl.tar.gz or git-view-x86_64-apple-darwin.tar.gz

  2. Extract into your local directory

# Linux
$ tar -xf git-view-x86_64-unknown-linux-gnu.tar.gz
$ tar -xf git-view-x86_64-unknown-linux-musl.tar.gz

# macOS
$ tar -xf git-view-x86_64-apple-darwin.tar.gz
  1. Move into ~/bin
# Create ~/bin if it does not exist
$ mkdir -p ~/bin
$ mv git-view ~/bin
  1. Set permissions for executable
$ chmod 755 ~/bin/git-view
  1. Ensure $PATH is updated
# Only required if git-view exists within a path not already included within $PATH

# Linux
$ echo 'export PATH=~/bin:$PATH' >> ~/.bashrc 
$ source ~/.bashrc

# macOS
$ echo 'export PATH=~/bin:$PATH' >> ~/.bash_profile
$ source ~/.bash_profile
  1. Verify installation
$ git view --version
git-view 0.1.0

Help

help

Contributing

First, thanks for your interest in contributing to this project! Please read the CONTRIBUTING.md before contributing!

License

MIT License

Acknowledgement

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

Dependencies

~3–5.5MB
~135K SLoC