Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/wowu/pro

⚡ A single command to quickly open current PR in browser. Supports GitHub and GitLab.
https://github.com/wowu/pro

command-line github gitlab go pull-requests terminal

Last synced: 3 days ago
JSON representation

⚡ A single command to quickly open current PR in browser. Supports GitHub and GitLab.

Host: GitHub
URL: https://github.com/wowu/pro
Owner: wowu
License: mit
Created: 2022-07-01T17:51:30.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-12-17T14:30:26.000Z (6 days ago)
Last Synced: 2024-12-20T09:06:06.217Z (3 days ago)
Topics: command-line, github, gitlab, go, pull-requests, terminal
Language: Go
Homepage:
Size: 1.72 MB
Stars: 43
Watchers: 3
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # `pro` - Pull Request Opener 

[![](https://img.shields.io/github/v/release/wowu/pro?label=version)](https://github.com/wowu/pro/releases/latest)

[![](https://img.shields.io/badge/platform-windows%20%7C%20macos%20%7C%20linux-lightgrey)](#installation)

A single command to open current PR in browser. Supports GitHub and GitLab. Available for macOS, Linux and Windows.

![pro](pro.png)

- [Demo](#demo)

- [Installation](#installation)

  - [Homebrew (macOS/Linux) - recommended](#homebrew-macoslinux---recommended)

  - [Scoop (Windows)](#scoop-windows)

  - [dpkg (Ubuntu/Debian)](#dpkg-ubuntudebian)

  - [Download latest binary (Linux)](#download-latest-binary-linux)

  - [Go package](#go-package)

  - [Compile from source](#compile-from-source)

  - [Precompiled binaries](#precompiled-binaries)

- [Usage](#usage)

  - [Authorize GitHub / GitLab](#authorize-github--gitlab)

    - [GitHub](#github)

    - [GitLab](#gitlab)

  - [Open Pull Request in default browser](#open-pull-request-in-default-browser)

## Demo

![pro](pro.gif)

## Installation

### Homebrew (macOS/Linux) - recommended

```bash

brew install wowu/tap/pro

```

### Scoop (Windows)

```bash

scoop bucket add wowu https://github.com/wowu/scoop.git

scoop install wowu/pro

```

### dpkg (Ubuntu/Debian)

```bash

wget https://github.com/wowu/pro/releases/latest/download/pro-linux-amd64.deb

dpkg -i pro-linux-amd64.deb

```

Replace `amd64` with `arm64` if you are on ARM.

### Download latest binary (Linux)

```bash

curl -sSL -o /usr/local/bin/pro https://github.com/wowu/pro/releases/latest/download/pro-linux-amd64

chmod +x /usr/local/bin/pro

```

Replace `amd64` with `arm64` if you are on ARM.

### Go package

```bash

go install github.com/wowu/pro@latest

```

`pro` binary will be installed in `$GOPATH/bin` (most likely `~/go/bin/pro`).

### Compile from source

1. Install Go (`brew install go` or [see offical docs](https://go.dev/doc/install))

2. Clone the repository and build the project:

   ```bash

   git clone [email protected]:Wowu/pro.git && cd pro

   go build

   ```

### Precompiled binaries

Download binaries from the [releases page](https://github.com/wowu/pro/releases/latest).

## Usage

### Authorize GitHub / GitLab

`pro` uses GitHub or GitLab API to find Pull Request related to current branch. Access is granted via personal access tokens.

#### GitHub

Use `auth` command to login:

```bash

pro auth github

```

You will be asked to [generate personal access token](https://github.com/settings/tokens/new?description=pro+cli&scopes=repo) and paste it in the prompt. It's recommended to change "Expiration" to "No expiration" before creating the token. Token will be stored in `~/.config/pro/config.yml`.

#### GitLab

Use `auth` command to login:

```bash

pro auth gitlab

```

You will be asked to [generate personal access token](https://gitlab.com/-/profile/personal_access_tokens?name=pro+cli&scopes=read_api) and paste it in the prompt. Token will be stored in `~/.config/pro/config.yml`.

### Open Pull Request in default browser

To open current Pull Request simply type:

```bash

pro

```

If you're on the main branch (`main`, `master`, `trunk`, etc.) repository homepage will be opened instead. If no PR matching current branch is found, a URL to create new Pull Request will be printed.

Use `-p | --print` flag to print the Pull Request URL instead of opening it in default browser:

```bash

pro -p

```

Use `-c | --copy` flag to copy the Pull Request URL to clipboard instead of opening it in default browser:

```bash

pro -c

```