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

https://github.com/nu0ma/pr-watcher

A CLI dashboard for real-time monitoring of GitHub PR status in your terminal.
https://github.com/nu0ma/pr-watcher

bun

Last synced: 2 months ago
JSON representation

A CLI dashboard for real-time monitoring of GitHub PR status in your terminal.

Awesome Lists containing this project

README

          

# pr-watcher

A CLI dashboard for real-time monitoring of GitHub PR status in your terminal.

Displays your created PRs, review requests, and items requiring action at a glance.

![pr-watcher screenshot](./docs/screenshot.png)

## Prerequisites

- [GitHub CLI (`gh`)](https://cli.github.com/) installed and authenticated

```sh
gh auth status # Check authentication status
```

## Installation

```sh
# bun
bun add -g @nu0ma/pr-watcher

# npm
npm install -g @nu0ma/pr-watcher
```

Or run directly without installing:

```sh
# bun
bunx @nu0ma/pr-watcher

# npm
npx @nu0ma/pr-watcher
```

## Usage

```sh
pr-watcher
```

### Options

| Flag | Description | Default |
|---|---|---|
| `--interval`, `-i` | Auto-refresh interval (minutes) | `10` |

```sh
# Refresh every 5 minutes
pr-watcher --interval 5
pr-watcher -i 5
```

## Development

```sh
bun install
bun run dev
```

## Key Bindings

| Key | Action |
|---|---|
| `r` | Manually trigger an immediate refresh |
| `q` / `Ctrl+C` | Quit |

## Display

- **My PRs** — Your open PRs (with review status and comment count)
- **Review Requests** — PRs where your review is requested
- **Action Required** — PRs with unread notifications (new comments, review requests, etc.)