prr(1)

📦
version 0.21.0 · 3 versions
, in ubuntu stonking

💖 prr — a little love letter to mailing-list-style code review 💖

okay bestie, gather round, because this is <italic>prr</italic> from the <cyan>General Commands Manual</cyan> section — manual page prr(1), if you're being formal about it — and she is literally here to change how you review pull requests. 🦋

✨ NAME ✨

prr — mailing list style code reviews for GitHub. that's it, that's the whole vibe. 👑

🌸 SYNOPSIS 🌸

prr [--config] [-h|--help] [-V|--version] <subcommands>

💅 DESCRIPTION 💅

so <hotpink>prr</hotpink> is a tool that brings mailing list style code reviews to GitHub PRs. which means: offline reviews, and inline comments. more or less. 🎀

and the way she does it is by introducing a whole new workflow for reviewing PRs, and honestly? obsessed:

  1. Download the PR into a <purple>"review file"</purple> on your filesystem
  2. Mark up the review file using your favorite text editor
  3. Submit the review at your convenience

like, your editor, your rules, your time. main character energy fr fr. 😌

for full documentation, please visit https://doc.dxuuu.xyz/prr/. iykyk. 💜

✨ OPTIONS ✨

  • --config <CONFIG> — Path to config file. tell her where your config lives and she'll go get it. 🗂️
  • -h, --help — Print help (see a summary with -h). yes, lowercase -h gives you the short version. iconic behavior honestly. 🙈
  • -V, --version — Print version. one capital V, no drama. ⭐

🎀 SUBCOMMANDS 🎀

these are her girls, her little squad, her whole support system:

  • prr-get(1) — Get a pull request and begin a review. the beginning of the story. 🌈
  • prr-edit(1) — Open an existing review in $EDITOR. she respects your editor choice, as she should. ✏️
  • prr-submit(1) — Submit a review. the grand finale. 💥
  • prr-apply(1) — Apply a pull request to the working directory. get those changes on your disk. 🧚
  • prr-status(1) — Print a status summary of all known reviews. peak "where am i, what is happening" energy. 💀
  • prr-remove(1) — Remove a review. sometimes you gotta let things go bestie. 🍓

🌟 VERSION 🌟

v0.21.0 — she's in her v0.21.0 era and thriving. 💖

👑 AUTHORS 👑

Daniel Xu <dxu@apache.org> — the mastermind, the blueprint, the moment. give her a round of applause. 🫶

okay that's the whole page, and as a lil sign-off: this was prr version 0.21.0 from the prr(1) manual-page world, and she says bye bestie, go review something beautiful. no cap. ✨💅🌸

📦 where this page comes from