pr-agent README

The project's README from github.com/The-PR-Agent/pr-agent. As one markdown file: README.md.


logo
The Original Open-Source PR Reviewer

GitHub

This repository contains the open-source PR Agent Project. It is not the Qodo offering for open-source projects.

PR-Agent is an open-source, AI-powered code review agent and a community-maintained legacy project of Qodo. It is distinct from Qodo's primary AI code review offering, which provides a feature-rich, context-aware experience. Qodo offers a free version for open-source projects and integrates seamlessly with GitHub, GitLab, Bitbucket, and Azure DevOps for high-quality automated reviews.

Sponsors

PR-Agent is a community-maintained open-source project, with its ongoing development supported by our sponsors. If you'd like to support the project, consider becoming a sponsor.

🥇 Gold Sponsor

Qodo — Gold sponsor

Free version of Qodo for open-source projects

Table of Contents

Getting Started

[!NOTE] Docker Hub namespace migration. Releases 0.34.2 and later are published under pragent/pr-agent. Older releases (up to and including v0.31) remain available at the legacy codiumai/pr-agent namespace as a frozen archive — no new images are pushed there. Update any pinned image: / docker pull / uses: docker:// references when upgrading to 0.34.2+.

🚀 Quick Start for PR-Agent

Add automated PR reviews to your repository with a simple workflow file:

# .github/workflows/pr-agent.yml
name: PR Agent
on:
  pull_request:
    types: [opened, synchronize]
jobs:
  pr_agent_job:
    runs-on: ubuntu-latest
    steps:
    - name: PR Agent action step
      uses: the-pr-agent/pr-agent@main
      env:
        OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Full GitHub Action setup guide

2. CLI Usage (Local Development)

Run PR-Agent locally on your repository:

pip install pr-agent
export OPENAI_KEY=your_key_here
pr-agent --pr_url https://github.com/owner/repo/pull/123 review

Complete CLI setup guide

3. Other Platforms

News and Updates

Full notes for every release are on the Releases page.

Why Use PR-Agent?

🎯 Built for Real Development Teams

Fast & Affordable: Each tool (/review, /improve, /ask) uses a single LLM call (~30 seconds, low cost)

Handles Any PR Size: Our PR Compression strategy effectively processes both small and large PRs

Highly Customizable: JSON-based prompting allows easy customization of review categories and behavior via configuration files

Platform Agnostic:

Open Source Benefits:

Features

See the current feature and git provider support matrix in the PR-Agent documentation.

⚠️ /help_docs is temporarily disabled since v0.36.1 pending a fix for a credential-exposure issue (#2445).

See It in Action

/describe

/review

/improve

Usage Examples

PR-Agent tools run as a comment on a PR or from the CLI. A few common ones:

# Comment on a PR (GitHub/GitLab/Bitbucket/…):
/describe
/review
/improve
/ask "What does this PR change?" # free-text Q&A about the PR

# Or locally via the CLI:
pr-agent --pr_url <PR_URL> review

See the Tools docs for the full list of tools with example commands, and each tool's page for screenshots and options.

How It Works

The following diagram illustrates PR-Agent tools and their flow:

PR-Agent Tools

Data Privacy

Self-hosted PR-Agent

Contributing

To contribute to the project, get started by reading our Contributing Guide.

For local verification, run PYTHONPATH=. uv run pytest from the repository root; it discovers the unit-test suite under tests/unittest by default. End-to-end tests under tests/e2e_tests require provider credentials and should be invoked explicitly, for example PYTHONPATH=. uv run pytest tests/e2e_tests/test_github_app.py.

Big News for PR-Agent

PR-Agent has a new home!

After years of building this tool alongside the community, Qodo has donated PR-Agent to the open-source community - and we couldn't be more excited about what comes next.

The project now lives in the PR-Agent org on GitHub, is fully community-owned, and is open for contributions and additional maintainers.

What else changed:

❤️ Community

This open-source release remains here as a community contribution from Qodo — the origin of modern AI-powered code collaboration. We’re proud to share it and inspire developers worldwide.

The project now has its first external maintainer, Naor (@naorpeled), and is currently in the process of being donated to an open-source foundation.

pr-agent (The-PR-Agent/pr-agent)

Searching Database…

13.4K ·GitHub
Pr-agent
What is this?An open-source, AI-powered code review agent for pull requests — the original open-source PR reviewer, now community-owned after being donated by Qodo.
Is this a hosted service or something I run myself?You run it in your own workflow: it deploys as a GitHub Action, a local CLI, Docker, self-hosted or webhooks. The hosted commercial product is a separate offering called Qodo.
Do I need an OpenAI API key, or will other models work?Bring any model: OpenAI GPT, Anthropic Claude, Google Gemini, DeepSeek, Mistral, or anything reachable through LiteLLM — including local models via Ollama.
Any version pitfalls before I install it?Yes — since 0.34.2 Docker images publish under the pragent/pr-agent namespace, so update any pinned image references when upgrading. Also, /helpdocs is disabled since v0.36.1 pending a credential-exposure fix.
Does it work outside GitHub?Yes — besides GitHub it supports GitLab, BitBucket, Azure DevOps and Gitea as git providers.
Where does my code go when it is reviewed?You keep control: self-hosted PR-Agent runs in your own infrastructure — if you host it with your own OpenAI API key, the data flow is between you and OpenAI.
What can I actually ask it to do on a PR?Its tools run as a comment on the PR or from the CLI — common ones are /review for a review, /improve for code suggestions and /ask for questions about the diff; the Tools docs list the rest.
Can I customize what the review focuses on?Yes — JSON-based prompting lets you adjust review categories and behavior via configuration files, and being open source you can change the prompts outright, with no vendor lock-in.
Is this the same product as Qodo?No — this repo is the community-owned project Qodo donated to the PR-Agent org, now open to external maintainers. Qodo (formerly Qodo Merge) evolved into a separate, feature-rich AI code review platform.
What are similar projects?open-swe, jev-code-reviewer, open-code-review, claude-code-action, codex-guard, pulls.review, oh-my-pi, Baize
Which topics is it in?pull-request, coding-assistant, devtools, code-quality, code-review, github-actions, github, ollama, anthropic, coding-agent, ai-agent, openai
Creator
The-PR-Agent
Size
133.1 MB
Stars
13.4K
Updated
CommitOct 18Releasev0.48.0Oct 16
Age
3y
Commits · 90 Days