mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-12-12 02:45:18 +00:00
Clarify README: PR-Agent vs. Qodo Merge (#2016)
* docs: clarify differences between PR-Agent and Qodo Merge in README - Added clear header explaining PR-Agent is open source, Qodo Merge is hosted - Created comparison table showing setup time and costs upfront - Added dedicated "PR-Agent vs Qodo Merge" section with detailed comparison - Restructured "Getting Started" to focus on PR-Agent with code examples - Enhanced "Why Use PR-Agent?" to emphasize open source benefits - Updated Qodo Merge section to be factual rather than sales-focused - Made the README more developer-friendly and less confusing for newcomers * revert: undo unintended changes to .gitignore * docs: clarify Qodo Merge enhances open-source features Updated the comparison table to better explain that Qodo Merge enhances the existing open-source features rather than just adding separate advanced features. This makes it clearer that both versions are sophisticated, with Qodo Merge building upon the open-source foundation. * docs: add navigation links and improve section title consistency - Added clickable links in Quick Start Options table to relevant sections - Updated "Want Zero-Setup? Try Qodo Merge" to "Try Qodo Merge (Zero Setup)" - Improved navigation and maintained consistent phrasing between options - Makes it easier for users to jump directly to setup instructions
This commit is contained in:
Itamar Friedman
GitHub
parent
ae4fc71603
commit
ead49dc605
1 changed files with 134 additions and 28 deletions
162
README.md
162
README.md
|
|
@ -15,7 +15,20 @@
|
||||||
[Tools Guide](https://qodo-merge-docs.qodo.ai/tools/) |
|
[Tools Guide](https://qodo-merge-docs.qodo.ai/tools/) |
|
||||||
[Qodo Merge](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) 💎
|
[Qodo Merge](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) 💎
|
||||||
|
|
||||||
PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedback and suggestions
|
## Open-Source AI-Powered Code Review Tool
|
||||||
|
|
||||||
|
**PR-Agent** is a free, open-source tool that provides AI-powered code review and PR assistance. Run it locally, on your CI/CD, or self-host it.
|
||||||
|
|
||||||
|
**[Qodo Merge](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) 💎** is the hosted, enterprise version with additional features, zero-setup, and priority support.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Quick Start Options
|
||||||
|
|
||||||
|
| **Option** | **Best For** | **Setup Time** | **Cost** |
|
||||||
|
|------------|--------------|----------------|----------|
|
||||||
|
| **[PR-Agent (Open Source)](#-quick-start-for-pr-agent-open-source)** | Developers who want full control, self-hosting, or custom integrations | 5-15 minutes | Free |
|
||||||
|
| **[Qodo Merge](#-try-qodo-merge-zero-setup)** | Teams wanting zero-setup, enhancing the open-source features, additional enterprise features, and managed hosting | 2 minutes | Free tier available |
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
[](https://chromewebstore.google.com/detail/qodo-merge-ai-powered-cod/ephlnjeghhogofkifjloamocljapahnl)
|
[](https://chromewebstore.google.com/detail/qodo-merge-ai-powered-cod/ephlnjeghhogofkifjloamocljapahnl)
|
||||||
|
|
@ -29,6 +42,7 @@ PR-Agent aims to help efficiently review and handle pull requests, by providing
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
|
- [PR-Agent vs Qodo Merge](#pr-agent-vs-qodo-merge)
|
||||||
- [Getting Started](#getting-started)
|
- [Getting Started](#getting-started)
|
||||||
- [News and Updates](#news-and-updates)
|
- [News and Updates](#news-and-updates)
|
||||||
- [Why Use PR-Agent?](#why-use-pr-agent)
|
- [Why Use PR-Agent?](#why-use-pr-agent)
|
||||||
|
|
@ -41,33 +55,95 @@ PR-Agent aims to help efficiently review and handle pull requests, by providing
|
||||||
- [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
- [Links](#links)
|
- [Links](#links)
|
||||||
|
|
||||||
|
## PR-Agent vs Qodo Merge
|
||||||
|
|
||||||
|
### PR-Agent (This Repository) - Open Source
|
||||||
|
|
||||||
|
✅ **What you get:**
|
||||||
|
- Complete source code access and customization
|
||||||
|
- Self-hosted deployment options
|
||||||
|
- All core AI review tools (`/describe`, `/review`, `/improve`, `/ask`)
|
||||||
|
- Support for GitHub, GitLab, BitBucket, Azure DevOps
|
||||||
|
- CLI usage for local development
|
||||||
|
- Free forever
|
||||||
|
|
||||||
|
⚙️ **What you need to manage:**
|
||||||
|
- Your own API keys (OpenAI, Claude, etc.)
|
||||||
|
- Infrastructure and hosting
|
||||||
|
- Updates and maintenance
|
||||||
|
- Configuration management
|
||||||
|
|
||||||
|
### Qodo Merge - Hosted Solution
|
||||||
|
|
||||||
|
✅ **What you get (everything above plus):**
|
||||||
|
- Zero-setup installation (2-minute GitHub app install)
|
||||||
|
- Managed infrastructure and automatic updates
|
||||||
|
- Advanced features: CI feedback, code suggestions tracking, custom prompts
|
||||||
|
- Priority support and feature requests
|
||||||
|
- Enhanced privacy with zero data retention
|
||||||
|
- Free tier: 75 PR reviews/month per organization
|
||||||
|
|
||||||
|
💰 **Pricing:**
|
||||||
|
- Free tier available
|
||||||
|
- Paid plans for unlimited usage
|
||||||
|
- [View pricing details](https://www.qodo.ai/pricing/)
|
||||||
|
|
||||||
|
**👨💻 Developer Recommendation:** Start with PR-Agent if you want to experiment, customize heavily, or have specific self-hosting requirements. Choose Qodo Merge if you want to focus on coding rather than tool maintenance.
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
### Try it Instantly
|
### 🚀 Quick Start for PR-Agent (Open Source)
|
||||||
|
|
||||||
|
#### 1. Try it Instantly (No Setup)
|
||||||
Test PR-Agent on any public GitHub repository by commenting `@CodiumAI-Agent /improve`
|
Test PR-Agent on any public GitHub repository by commenting `@CodiumAI-Agent /improve`
|
||||||
|
|
||||||
### GitHub Action
|
#### 2. GitHub Action (Recommended)
|
||||||
Add automated PR reviews to your repository with a simple workflow file using [GitHub Action setup guide](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action)
|
Add automated PR reviews to your repository with a simple workflow file:
|
||||||
|
```yaml
|
||||||
|
# .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](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action)
|
||||||
|
|
||||||
#### Other Platforms
|
#### 3. CLI Usage (Local Development)
|
||||||
|
Run PR-Agent locally on your repository:
|
||||||
|
```bash
|
||||||
|
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](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#local-repo-cli)
|
||||||
|
|
||||||
|
#### 4. Other Platforms
|
||||||
- [GitLab webhook setup](https://qodo-merge-docs.qodo.ai/installation/gitlab/)
|
- [GitLab webhook setup](https://qodo-merge-docs.qodo.ai/installation/gitlab/)
|
||||||
- [BitBucket app installation](https://qodo-merge-docs.qodo.ai/installation/bitbucket/)
|
- [BitBucket app installation](https://qodo-merge-docs.qodo.ai/installation/bitbucket/)
|
||||||
- [Azure DevOps setup](https://qodo-merge-docs.qodo.ai/installation/azure/)
|
- [Azure DevOps setup](https://qodo-merge-docs.qodo.ai/installation/azure/)
|
||||||
|
|
||||||
### CLI Usage
|
### 💎 Try Qodo Merge (Zero Setup)
|
||||||
Run PR-Agent locally on your repository via command line: [Local CLI setup guide](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#local-repo-cli)
|
|
||||||
|
|
||||||
### Qodo Merge as post-commit in your local IDE
|
If you prefer a hosted solution without managing infrastructure:
|
||||||
See [here](https://github.com/qodo-ai/agents/tree/main/agents/qodo-merge-post-commit)
|
|
||||||
|
|
||||||
### Discover Qodo Merge 💎
|
1. **[Install Qodo Merge GitHub App](https://github.com/marketplace/qodo-merge-pro)** (2 minutes)
|
||||||
Zero-setup hosted solution with advanced features and priority support
|
2. **[FREE for Open Source](https://github.com/marketplace/qodo-merge-pro-for-open-source)**: Full features, zero cost for public repos
|
||||||
- **[FREE for Open Source](https://github.com/marketplace/qodo-merge-pro-for-open-source)**: Full features, zero cost for public repos
|
3. **Free Tier**: 75 PR reviews/month for private repos
|
||||||
- [Intro and Installation guide](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/)
|
4. **[View Plans & Pricing](https://www.qodo.ai/pricing/)**
|
||||||
- [Plans & Pricing](https://www.qodo.ai/pricing/)
|
|
||||||
|
|
||||||
### Qodo Merge as a Post-commit in Your Local IDE
|
[Complete Qodo Merge setup guide](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/)
|
||||||
You can receive automatic feedback from Qodo Merge on your local IDE after each [commit](https://github.com/qodo-ai/agents/tree/main/agents/qodo-merge-post-commit)
|
|
||||||
|
### 💻 Local IDE Integration
|
||||||
|
Receive automatic feedback in your IDE after each commit: [Qodo Merge post-commit agent](https://github.com/qodo-ai/agents/tree/main/agents/qodo-merge-post-commit)
|
||||||
|
|
||||||
|
|
||||||
## News and Updates
|
## News and Updates
|
||||||
|
|
@ -120,14 +196,24 @@ Read more about it [here](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discus
|
||||||
|
|
||||||
## Why Use PR-Agent?
|
## Why Use PR-Agent?
|
||||||
|
|
||||||
A reasonable question that can be asked is: `"Why use PR-Agent? What makes it stand out from existing tools?"`
|
### 🎯 Built for Real Development Teams
|
||||||
|
|
||||||
Here are some advantages of PR-Agent:
|
**Fast & Affordable**: Each tool (`/review`, `/improve`, `/ask`) uses a single LLM call (~30 seconds, low cost)
|
||||||
|
|
||||||
- We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single LLM call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably.
|
**Handles Any PR Size**: Our [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) effectively processes both small and large PRs
|
||||||
- Our [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) is a core ability that enables to effectively tackle both short and long PRs.
|
|
||||||
- Our JSON prompting strategy enables us to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the [configuration](pr_agent/settings/configuration.toml) file. Adding additional categories is easy and accessible.
|
**Highly Customizable**: JSON-based prompting allows easy customization of review categories and behavior via [configuration files](pr_agent/settings/configuration.toml)
|
||||||
- We support **multiple git providers** (GitHub, GitLab, BitBucket), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT, Claude, Deepseek, ...)
|
|
||||||
|
**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
|
## Features
|
||||||
|
|
||||||
|
|
@ -240,13 +326,33 @@ It does not have 'edit' access to your repo, for example, so it cannot update th
|
||||||
|
|
||||||
## Qodo Merge 💎
|
## Qodo Merge 💎
|
||||||
|
|
||||||
[Qodo Merge](https://www.qodo.ai/pricing/) is a hosted version of PR-Agent, provided by Qodo. It is available for a monthly fee, and provides the following benefits:
|
[Qodo Merge](https://www.qodo.ai/pricing/) is the hosted version of PR-Agent with additional enterprise features.
|
||||||
|
|
||||||
1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the Qodo Merge app to your GitHub/GitLab/BitBucket repo.
|
### Key Differences from Open Source PR-Agent:
|
||||||
2. **Improved privacy** - No data will be stored or used to train models. Qodo Merge will employ zero data retention, and will use an OpenAI account with zero data retention.
|
|
||||||
3. **Improved support** - Qodo Merge users will receive priority support, and will be able to request new features and capabilities.
|
**Infrastructure & Management:**
|
||||||
4. **Extra features** - In addition to the benefits listed above, Qodo Merge will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results.
|
- Fully managed hosting and automatic updates
|
||||||
See [here](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) for a list of features available in Qodo Merge.
|
- Zero-setup installation (GitHub/GitLab/BitBucket app)
|
||||||
|
- No need to manage API keys or infrastructure
|
||||||
|
|
||||||
|
**Enhanced Privacy:**
|
||||||
|
- Zero data retention policy
|
||||||
|
- No data used for model training
|
||||||
|
- Enterprise-grade security
|
||||||
|
|
||||||
|
**Additional Features:**
|
||||||
|
- Advanced code suggestions with tracking
|
||||||
|
- CI feedback analysis
|
||||||
|
- Custom prompts and labels
|
||||||
|
- Static code analysis integration
|
||||||
|
- Priority support
|
||||||
|
|
||||||
|
**Pricing:**
|
||||||
|
- Free tier: 75 PR reviews/month per organization
|
||||||
|
- Paid plans for unlimited usage
|
||||||
|
- Free for open source projects
|
||||||
|
|
||||||
|
See [complete feature comparison](https://qodo-merge-docs.qodo.ai/overview/pr_agent_pro/) for detailed differences.
|
||||||
|
|
||||||
## How It Works
|
## How It Works
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue