gh-prs

A gh cli extension to display a dashboard with pull requests by filters you care about.

Installation

Installation requires a minimum version (2.0.0) of the the Github CLI to support extensions.

1. Install the gh cli - see the installation/upgrade instructions

2. Install this extension:

gh extension install dlvhdr/gh-prs

3. To get the icons to render properly you should download and install a Nerd font from https://www.nerdfonts.com/. Then, select that font as your font for the terminal.

Installing Manually

if you want to install this extension manually, do these steps:

1. clone repo

   # git
   git clone https://github.com/dlvhdr/gh-prs
   
   # github cli
   gh repo clone dlvhdr/gh-prs

2. cd to it

   cd gh-prs

3. install it locally

   gh extension install .

Configuring

Configuration is provided within a config.yml file under the extension's directory (usually ~/.config/prs/)

The default config.yml file contains:

prSections:
  - title: My Pull Requests
    filters: is:open author:@me
  - title: Needs My Review
    filters: is:open review-requested:@me
  - title: Subscribed
    filters: is:open -author:@me repo:cli/cli repo:dlvhdr/gh-prs
    limit: 50 # optional limit per section
defaults:
  prsLimit: 20 # global limit
  preview:
    open: true
    width: 60

Adding PR sections is as easy as adding to the list of prSections where the properties are:

• title - shown in the TUI
• filters - how the repo's PRs should be filtered - these are plain github filters

Usage

Run:

gh prs

Then press ? for help.

Author

Dolev Hadar [email protected]