README.md

🚀 PR Agent - The Original Open-Source PR Reviewer.

This repository contains the open-source PR Agent Project. It is not the Qodo free tier.

Try the free version on our website.

👉Get Started Now

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 now offers a free tier that integrates seamlessly with GitHub, GitLab, Bitbucket, and Azure DevOps for high-quality automated reviews.

Table of Contents

• Getting Started
• Why Use PR-Agent?
• Features
• See It in Action
• Try It Now
• How It Works
• Data Privacy
• Contributing

Getting Started

🚀 Quick Start for PR-Agent

1. Try it Instantly (No Setup)

Test PR-Agent on any public GitHub repository by commenting @CodiumAI-Agent /improve

2. GitHub Action (Recommended)

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: Codium-ai/pr-agent@main
      env:
        OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Full GitHub Action setup guide

3. 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

4. Other Platforms

• GitLab webhook setup
• BitBucket app installation
• Azure DevOps setup

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:

• Git Providers: GitHub, GitLab, BitBucket, Azure DevOps, Gitea
• Deployment: CLI, GitHub Actions, Docker, self-hosted, webhooks
• AI Models: OpenAI GPT, Claude, Deepseek, and more

Open Source Benefits:

• Full control over your data and infrastructure
• Customize prompts and behavior for your team's needs
• No vendor lock-in
• Community-driven development

Features

PR-Agent offers comprehensive pull request functionalities integrated with various git providers:

		GitHub	GitLab	Bitbucket	Azure DevOps	Gitea
TOOLS	Describe	✅	✅	✅	✅	✅
	Review	✅	✅	✅	✅	✅
	Improve	✅	✅	✅	✅	✅
	Ask	✅	✅	✅	✅
	⮑ Ask on code lines	✅	✅
	Help Docs	✅	✅	✅
	Update CHANGELOG	✅	✅	✅	✅
USAGE	CLI	✅	✅	✅	✅	✅
	App / webhook	✅	✅	✅	✅	✅
	Tagging bot	✅
	Actions	✅	✅	✅	✅
CORE	Adaptive and token-aware file patch fitting	✅	✅	✅	✅
	Chat on code suggestions	✅	✅
	Dynamic context	✅	✅	✅	✅
	Fetching ticket context	✅	✅	✅
	Incremental Update	✅
	Interactivity	✅	✅
	Local and global metadata	✅	✅	✅	✅
	Multiple models support	✅	✅	✅	✅
	PR compression	✅	✅	✅	✅
	RAG context enrichment	✅		✅
	Self reflection	✅	✅	✅	✅

---

See It in Action

/describe

---

/review

---

/improve

---

Try It Now

Try the GPT-5 powered PR-Agent instantly on your public GitHub repository. Just mention @CodiumAI-Agent and add the desired command in any PR comment. The agent will generate a response based on your command. For example, add a comment to any pull request with the following text:

@CodiumAI-Agent /review

and the agent will respond with a review of your PR.

Note that this is a promotional bot, suitable only for initial experimentation. It does not have 'edit' access to your repo, for example, so it cannot update the PR description or add labels (@CodiumAI-Agent /describe will publish PR description as a comment). In addition, the bot cannot be used on private repositories, as it does not have access to the files there.

How It Works

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

Data Privacy

Self-hosted PR-Agent

• If you host PR-Agent with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here: https://openai.com/enterprise-privacy

Contributing

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

❤️ 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.