Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dhth/prs
Stay updated on PRs from your terminal
https://github.com/dhth/prs
bubbletea github pull-requests tui
Last synced: about 1 month ago
JSON representation
Stay updated on PRs from your terminal
- Host: GitHub
- URL: https://github.com/dhth/prs
- Owner: dhth
- License: mit
- Created: 2024-03-29T15:26:19.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T18:58:48.000Z (about 2 months ago)
- Last Synced: 2024-10-26T05:04:01.510Z (about 2 months ago)
- Topics: bubbletea, github, pull-requests, tui
- Language: Go
- Homepage: https://tools.dhruvs.space/prs
- Size: 1.44 MB
- Stars: 104
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-tuis - prs
- charm-in-the-wild - prs - Stay up to date with your PRs. (_built with Bubble Tea_) (Applications / Development Tools)
- awesome-repositories - dhth/prs - Stay updated on PRs from your terminal (Go)
README
# prs
✨ Overview
---
`prs` lets you stay updated on pull requests from your terminal.
[source video](https://youtu.be/H81ru9cQhDo)
🤔 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**:
```sh
brew install dhth/tap/prs
```
**go**:
```sh
go install github.com/dhth/prs@latest
```
Or get the binaries directly from a [release][3]. Read more about verifying the
authenticity of released artifacts [here](#-verifying-release-artifacts).
🔑 Authentication
---
You can have `prs` make authenticated calls to GitHub on your behalf in either
of two ways:
- Have an authenticated instance of [gh](https://github.com/cli/cli) available
(recommended).
- Provide a valid Github token via `$GH_TOKEN`.
⚡️ Usage
---
`prs` has two modes:
- **Query mode** (default): lets you search PRs based on a query you provide (based
on github's [search
syntax](https://docs.github.com/en/search-github/searching-on-github/searching-issues-and-pull-requests))
- **Repos mode**: let you pick a repository from a predefined list
### Query Mode
```shell
prs --query='type:pr repo:neovim/neovim state:open label:lua linked:issue'
# view open PRs where you're the author
prs -q 'type:pr author:@me state:open'
# view open PRs where a review has been requested from you
PRS_QUERY='type:pr user-review-requested:@me state:open' prs
# read query from prs' config file
prs
```
### Repos Mode
```shell
prs --mode=repos --repos='dhth/prs,dhth/omm,dhth/hours'
PRS_REPOS='dhth/prs,dhth/omm,dhth/hours' prs --mode=repos
# read repos from prs' config file
prs -m repos
```
🛠️ Configuration
---
`prs` accepts configuration from any of the following:
- Command line flags (run `prs -h` for details)
- Environment variables (eg. `PRS_QUERY`)
- `prs`'s config file, which looks like this:
```yaml
num: 20
repos:
- dhth/omm
- dhth/hours
- dhth/prs
- neovim/neovim
- junegunn/fzf
- BurntSushi/ripgrep
- charmbracelet/bubbletea
- goreleaser/goreleaser
- dandavison/delta
query: 'type:pr repo:neovim/neovim state:open label:lua linked:issue'
```
For every configuration property, the order of priority is: `flag >>
environment variables >> config file`, ie, flags take the highest priority.
**[`^ back to top ^`](#prs)**
Screenshots
---
### PR List View
### PR Timeline List View
### PR Timeline Item Detail View
### PR Details View
**[`^ back to top ^`](#prs)**
Keyboard Shortcuts
---
### General
```text
q/esc/ctrl+c go back
Q quit from anywhere
? Open Help View
d Open PR Details View
ctrl+v Show PR details using gh
```
### PR List View
```text
Indicators for current review decision:
± implies CHANGES_REQUESTED
🟡 implies REVIEW_REQUIRED
✅ implies APPROVED
⏎/tab/shift+tab/2 Switch focus to PR Timeline View
ctrl+s Switch focus to Repo List View (when --mode=repos)
ctrl+d Show PR diff
ctrl+r Reload PR list
ctrl+b Open PR in browser
```
### PR Details View
```text
h/N/← Go to previous section
l/n/→ Go to next section
1/2/3... Go to specific section
J/] Go to next PR
K/[ Go to previous PR
d Go back to last view
ctrl+b Open PR in browser
```
### Timeline List View
```text
tab/shift+tab/1 Switch focus to PR List View
⏎/3 Show details for PR timeline item (when applicable)
ctrl+d Show PR diff
ctrl+b Open timeline item in browser
ctrl+r Reload PR timeline
```
### Timeline Item Detail View
```text
1 Switch focus to PR List View
2 Switch focus to PR Timeline List View
ctrl+d Show PR diff
ctrl+b Open timeline item in browser
h/N/← Go to previous section
l/n/→ Go to next section
```
### 🔐 Verifying release artifacts
In case you get the `prs` binary directly from a [release][3], you may want to
verify its authenticity. Checksums are applied to all released artifacts, and
the resulting checksum file is signed using
[cosign](https://docs.sigstore.dev/cosign/installation/).
Steps to verify (replace the version in the commands listed with the one you
want):
1. Download the following files from the release:
- prs_1.0.0_checksums.txt
- prs_1.0.0_checksums.txt.pem
- prs_1.0.0_checksums.txt.sig
2. Verify the signature:
```shell
cosign verify-blob prs_1.0.0_checksums.txt \
--certificate prs_1.0.0_checksums.txt.pem \
--signature prs_1.0.0_checksums.txt.sig \
--certificate-identity-regexp 'https://github\.com/dhth/prs/\.github/workflows/.+' \
--certificate-oidc-issuer "https://token.actions.githubusercontent.com"
```
3. Download the compressed archive you want, and validate its checksum:
```shell
curl -sSLO https://github.com/dhth/prs/releases/download/v1.0.0/prs_1.0.0_linux_amd64.tar.gz
sha256sum --ignore-missing -c prs_1.0.0_checksums.txt
```
3. If checksum validation goes through, uncompress the archive:
```shell
tar -xzf prs_1.0.0_linux_amd64.tar.gz
./prs
# profit!
```
Acknowledgements
---
`prs` is built using [bubbletea][1], and released via [goreleaser][2].
[1]: https://github.com/charmbracelet/bubbletea
[2]: https://github.com/goreleaser/goreleaser
[3]: https://github.com/dhth/prs/releases
**[`^ back to top ^`](#prs)**