prs

command module
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 2, 2024 License: MIT Imports: 1 Imported by: 0

README

prs

✨ Overview

prs lets you stay updated on the PRs you care about without leaving the terminal.

prs is not a replacement of gh, or the Github web UI itself, it simply allows you to get to the updates you care about in fewer key presses.

Usage

🤔 Motivation

For my day job as a tech lead, I need to stay updated on several PRs, and my hope is that prs will let me do that faster than the Github web UI (or other tools for that matter).

💾 Installation

homebrew:

brew install dhth/tap/prs

go:

go install github.com/dhth/prs@latest

🛠️ Pre-requisites

🛠️ Configuration

Create a configuration file that looks like the following. By default prs will look for this file at ~/.config/prs/prs.yml.

diff-pager: delta
pr-count: 20
sources:
- owner: owner
  repos:
    - name: repo-a
    - name: repo-b
    - name: repo-c

⚡️ Usage

prs
prs -config-file /path/to/config.yml

Screenshots

Screen 1

Screen 2

Screen 3

Reference Manual

prs Reference Manual

prs has 5 views:
- PR List View
- PR Timeline List View
- PR Review Comments View
- Repo List View
- Help View (this one)

Keyboard Shortcuts:

General
  <tab>       Switch focus between PR List and PR Timeline Pane
  1           Switch focus to PR List View
  2           Switch focus to PR Timeline List View
  3           Switch focus to PR Review Comments View
  <ctrl+s>    Switch focus to Repo List View
  ?           Switch focus to Help View

PR List/Timeline List View
  <ctrl+v>    Show PR details
  <ctrl+d>    Show PR diff

PR List View
  <ctrl+b>    Open PR in the browser
  <ctrl+r>    Reload PR list
  <enter>     Switch focus to PR Timeline View for currently selected PR

PR Timeline View
  <ctrl+b>    Open timeline item in browser
  <ctrl+r>    Reload timeline list
  <enter>     Switch focus to Review Comments View for currently selected item

Acknowledgements

prs is built using bubbletea.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL