|
1 | | -# 🚀 prs |
| 1 | +# prs |
2 | 2 |
|
3 | | -> Only shows PRs waiting on YOU |
| 3 | +GitHub CLI tool that shows which PRs that are actually waiting on you. That's it. |
4 | 4 |
|
5 | | -A fast CLI that filters GitHub PRs to show only what needs your attention. No more digging through dozens of PRs to find the ones that actually need you. |
| 5 | +Designed to be easily used for embedded low-power displays, or your shell initialization. |
6 | 6 |
|
7 | | -## Quick Start |
| 7 | +## Install |
8 | 8 |
|
9 | 9 | ```bash |
10 | | -go install github.com/ready-to-review/prs@latest |
11 | | -prs |
| 10 | +go install github.com/codeGROOVE-dev/prs@latest |
12 | 11 | ``` |
13 | 12 |
|
14 | | -**Requirements:** Go 1.23+ and GitHub CLI (`gh`) authenticated |
| 13 | +Requires Go 1.23+ and `gh` auth. |
15 | 14 |
|
16 | 15 | ## Usage |
17 | 16 |
|
18 | 17 | ```bash |
19 | | -# Show PRs you're involved with (filters out stale PRs) |
20 | | -prs |
21 | | - |
22 | | -# Only PRs waiting for your review |
23 | | -prs --blocked |
24 | | - |
25 | | -# Include old/stale PRs |
26 | | -prs --include-stale |
27 | | - |
28 | | -# Auto-refresh view |
29 | | -prs --watch |
30 | | - |
31 | | -# Get notified when PRs need attention |
32 | | -prs --notify |
| 18 | +prs # PRs you're involved with |
| 19 | +prs --blocked # Only PRs waiting for you |
| 20 | +prs --include-stale # Include ancient PRs |
| 21 | +prs --watch # Live updates |
| 22 | +prs --exclude-orgs google # Skip an organization (comma-separated) |
33 | 23 | ``` |
34 | 24 |
|
35 | | -## What You'll See |
36 | | - |
37 | | -### Default View (`prs`) |
38 | 25 |  |
39 | 26 |
|
40 | | -### Live Focus Mode (`prs --blocked --watch`) |
41 | | - |
42 | | - |
43 | | -## Options |
44 | | - |
45 | | -- `--blocked` - Only PRs blocking on you |
46 | | -- `--include-stale` - Include old PRs (hidden by default) |
47 | | -- `--watch` - Live updates with real-time WebSocket + polling |
48 | | -- `--exclude-orgs` - Comma-separated list of organizations to exclude |
49 | | -- `--verbose` - Show detailed logging |
50 | | - |
51 | | -### Color Output |
52 | | - |
53 | | -Colors are automatically adjusted based on your terminal capabilities. To disable colors entirely: |
54 | | - |
55 | | -```bash |
56 | | -NO_COLOR=1 prs |
57 | | -``` |
58 | | - |
59 | | -This respects the [NO_COLOR](https://no-color.org/) standard. |
60 | | - |
61 | | -## Status Icons |
| 27 | + |
62 | 28 |
|
63 | | -- 🚧 Draft PR |
64 | | -- ✅ Ready to merge |
65 | | -- 👍 Has approval |
66 | | -- 💥 Merge conflict |
67 | | -- ⏰ Stale PR |
68 | | -- ❌ Failing tests |
69 | | -- 📝 Regular PR |
| 29 | +Colors disabled with `NO_COLOR=1`. |
70 | 30 |
|
71 | | -## Why This Tool? |
| 31 | +## Real-time support |
72 | 32 |
|
73 | | -Stop context switching through GitHub tabs. This tool uses smart filtering to show only PRs that actually need your input - not PRs waiting on CI, other reviewers, or ones you've already reviewed. |
| 33 | +Due to GitHub webhook limitations, real-time updates are only available for GitHub orgs that install the [Ready to Review](https://github.com/apps/ready-to-review-beta) GitHub app. |
74 | 34 |
|
75 | | -Built fast in Go because your development tools shouldn't slow you down. |
| 35 | +Without the app, PRs are updated every minute, which should be enough for anyone TBH. |
0 commit comments