gh-prs's Introduction

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.

Install the gh cli - see the installation/upgrade instructions
Install this extension:

gh extension install dlvhdr/gh-prs

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:

clone repo

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

# github cli
gh repo clone dlvhdr/gh-prs

cd to it
```
cd gh-prs
```
install it locally
```
gh extension install .
```

Configuring

Configuration is provided within a sections.yml file under the extension's directory. If the configuration file is missing, a prompt to create it will be displayed when running gh prs.

Each section is defined by a top level array item and has the following properties:

title - shown in the TUI
repos - a list of repos to enumerate
filters - how the repo's PRs should be filtered - these are plain github filters

Example sections.yml file:

- title: My Pull Requests
  repos:
    - dlvhdr/gh-prs
  filters: author:@me
- title: Needs My Review
  repos:
    - dlvhdr/gh-prs
  filters: review-requested:@me
- title: Subscribed
  repos:
    - cli/cli
    - charmbracelet/glamour
    - charmbracelet/lipgloss
  filters: -author:@me