pulls.review README

The project's README from github.com/antfu/pulls.review. As one markdown file: README.md.

pulls.review Open Graph image

pulls.review

[!WARNING] Heavily work in progress.

Pull request review made simple. Groups changed files, summarizes what matters, and reviews them one scope at a time.

Use on Website

To use pulls.review on the website, simply visit pulls.review and follow the instructions to connect your GitHub account and start reviewing pull requests directly in your browser.

Use in GitHub

You can optionally install userscript to enhance the GitHub interface with pulls.review features.

Go to pulls.review and scroll down to the GitHub section to install the userscript.

Analyze pull requests from CI (Experimental)

Instead of each reviewer spending their own model key, let a workflow analyze every pull request once and post the result as a PR comment. pulls.review picks the comment up automatically for everyone who opens the PR there. Re-runs on an unchanged PR skip the model call.

# .github/workflows/pulls-review.yml
name: pulls.review
on:
  # The analysis only reads the diff through the API and never checks out PR code,
  # so `pull_request_target` is safe here and lets fork PRs get a comment too.
  pull_request_target:
    types: [opened, synchronize, reopened]

permissions:
  pull-requests: write

jobs:
  analyze:
    runs-on: ubuntu-latest
    steps:
      - uses: antfu/pulls.review@main
        with:
          api-key: ${{ secrets.VERCEL_AI_GATEWAY_API_KEY }}

provider is inferred from the key you pass (gateway for a Vercel AI Gateway token, anthropic, or openai-compatible with base-url); set it explicitly, along with model and locale, when you want to.

The action is a thin wrapper around the @pulls.review/actions CLI, which works anywhere a GitHub token and a model key are in the environment:

GITHUB_TOKEN=... ANTHROPIC_API_KEY=... npx @pulls.review/actions owner/repo#123

Every variable also has a PULLS_REVIEW_* form that takes precedence (PULLS_REVIEW_GITHUB_TOKEN, PULLS_REVIEW_PROVIDER, PULLS_REVIEW_API_KEY, PULLS_REVIEW_MODEL, PULLS_REVIEW_BASE_URL, PULLS_REVIEW_LOCALE); npx @pulls.review/actions --help lists everything.

Packages

Package What it is
packages/app The site at pulls.review and the github.com embed.
@pulls.review/core Fetching, parsing, grouping and summarizing diffs - runs in the browser and in Node.
@pulls.review/actions The CLI the GitHub Action runs.
pulls.review The standalone CLI for reviewing local git changes. Not implemented yet - the name is reserved.

Credits

Inspired heavily by Linear's PR review guides, thanks for the inspiration.

Sponsors

Sponsors

License

MIT License

pulls.review (antfu/pulls.review)

Searching Database…

546 ·GitHub
Pulls.review
What is this?pulls.review is a pull request review tool that groups the changed files by scope, summarizes what matters, and lets you review the PR one scope at a time instead of scrolling through the whole diff.
Is this a website, a browser script, or a CI tool?It is actually all three: a web app at pulls.review, an optional userscript that enhances the GitHub.com interface, and a GitHub Action for CI analysis; a standalone local CLI is also planned but not implemented yet.
How do I start reviewing PRs with this?Visit pulls.review, connect your GitHub account, and start reviewing pull requests directly in your browser; you can also install the userscript from the GitHub section of the site to bring the features onto github.com itself.
Is this stable enough to rely on right now?No, the README itself warns it is heavily work in progress, and the standalone CLI package is just a reserved name that has not been implemented yet.
What does the GitHub Action actually do?It runs a workflow that analyzes each pull request once with your chosen model and posts the result as a PR comment that pulls.review automatically picks up for every reviewer who opens that PR; re-running on an unchanged PR skips the model call.
What are the project's packages?The repo is a monorepo: packages/app is the pulls.review site and GitHub embed, @pulls.review/core handles fetching, parsing, grouping and summarizing diffs, and @pulls.review/actions is the CLI the GitHub Action runs.
What inspired pulls.review?The author says it was inspired heavily by Linear's pull request review guides.
Can I use any AI provider I want?Yes, it supports Anthropic, OpenAI-compatible endpoints with a custom base-url, or a Vercel AI Gateway token, and the provider is auto-detected from the key you supply.
What are similar projects?claude-code-action, eve-software-factory-template, pr-agent, open-swe, jev-code-reviewer, open-code-review, github-mcp-server, pr-lens
Which topics is it in?pull-request, userscript, vercel, ci-cd, code-review, github-actions, monorepo, github, anthropic, browser, web-app, openai
Creator
antfu
Size
2.5 MB
Stars
546
Updated
CommitOct 13Releasev0.3.3Oct 13
Age
1mo
Commits · 90 Days