Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yoannfleurydev/gitweb

🌲 Open the current remote repository in your browser
https://github.com/yoannfleurydev/gitweb

cli command-line git rust

Last synced: 11 days ago
JSON representation

🌲 Open the current remote repository in your browser

Awesome Lists containing this project

README

        

# gitweb

![Publish](https://github.com/yoannfleurydev/gitweb/workflows/Publish/badge.svg)

> Some of the flags and options are subject to change in the future.
> Ideas are welcome. Ideas are bulletproof (V).

`gitweb` is a command line interface I created mainly to learn Rust.

![preview](./docs/gitweb.gif)

## Intallation

### 🍺 The homebrew way

```sh
brew install yoannfleurydev/gitweb/gitweb
# or
brew tap yoannfleurydev/gitweb
brew install gitweb
```

### 📦 The Cargo way

```sh
cargo install gitweb
```

### ⚙️ The binary way

Download the binary from the [latest release](https://github.com/yoannfleurydev/gitweb/releases/latest) and put it in your PATH.

### 🖥 The MacPorts way

```
sudo port selfupdate
sudo port install gitweb
```

## Usage

`gitweb` will by default open the remote in the browser of the current
repository.

```
gitweb 0.3.1

USAGE:
gitweb [FLAGS] [OPTIONS]

FLAGS:
-h, --help Prints help information
-M, --merge-request Set the merge request flag
-V, --version Prints version information
-v, --verbose Set the verbosity of the command

OPTIONS:
-b, --branch Set the branch (alias for --tag)
-B, --browser Set the browser [env: BROWSER=]
-c, --commit Set a commit
-r, --remote Set the remote
-t, --tag Set the tag (alias for --branch)
```

## --branch, --tag

`gitweb` will open the current branch or tag on the remote repository. You can
override the behavior by giving either `--branch` or `--tag` flag with the
custom branch or tag you want to open in the browser.

## --browser

`gitweb` tries to start one of the following browser (in that order of priority):

- `--browser` option given in the command line
- `$BROWSER` on Linux 🐧 or `%BROWSER%` on Windows 🏁 (this is a non standard variable)
- the default web browser on the system

## --commit

`gitweb` will open the commit given as a parameter on the remote repository.

## --remote

`gitweb` will open the origin remote if it exists. You can override the behavior
by giving the `--remote` flag with the custom remote you want to open.