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
这是什么?一个开源的 AI 拉取请求(PR)代码审查工具——最早的开源 PR 审查助手,由 Qodo 捐赠给社区后,现在由社区维护。
这是托管服务,还是要我自己运行?它跑在你自己的工作流里:可以作为 GitHub Action、本地 CLI、Docker、自托管服务或 webhook 部署。托管的商业版是另一个独立产品,叫做 Qodo。
我需要 OpenAI 的 API 密钥吗,还是用其他模型也行?随便接哪个模型都行:OpenAI GPT、Anthropic Claude、Google Gemini、DeepSeek、Mistral,或者任何通过 LiteLLM 能访问的模型——包括通过 Ollama 运行的本地模型。
安装前有什么版本上的坑要注意?有——从 0.34.2 开始,Docker 镜像发布在 pragent/pr-agent 命名空间下,升级时要把固定写的镜像地址更新过来。另外,从 v0.36.1 起 /helpdocs 暂时停用,等待凭据泄露问题修复。
它在 GitHub 之外能用吗?能——除了 GitHub,它还支持 GitLab、BitBucket、Azure DevOps 和 Gitea 这些 git 托管平台。
审查时我的代码会传到哪里?控制权在你手上:自托管的 PR-Agent 跑在你自己的基础设施里——如果你用自己的 OpenAI API 密钥来部署,数据只在你和 OpenAI 之间流转。
在一个 PR 上我具体能让它做什么?它的各种工具以 PR 评论或 CLI 命令的方式触发——常用的有 /review 做代码审查、/improve 给出代码改进建议、/ask 针对 diff 提问;其余工具见 Tools 文档。
我能自定义审查关注的重点吗?可以——基于 JSON 的提示词配置让你通过配置文件调整审查的类别和行为;而且它是开源的,你可以直接改提示词本身,完全不会被厂商锁定。
它和 Qodo 是同一个产品吗?不是——这个仓库是 Qodo 捐赠给 PR-Agent 组织的社区项目,现在也对外开放维护者资格。Qodo(原名 Qodo Merge)则发展成了一个独立的功能更丰富的 AI 代码审查平台。
Size
133.1 MB
Stars
13.4K
Age
3y
Commits · 90 Days