mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-06 05:40:38 +08:00
106 lines
9.0 KiB
Markdown
106 lines
9.0 KiB
Markdown
# Overview
|
||
|
||
CodiumAI PR-Agent is an open-source tool to help efficiently review and handle pull requests.
|
||
|
||
- See the [Installation Guide](./installation/index.md) for instructions on installing and running the tool on different git platforms.
|
||
|
||
- See the [Usage Guide](./usage-guide/index.md) for instructions on running the PR-Agent commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened.
|
||
|
||
- See the [Tools Guide](./tools/index.md) for a detailed description of the different tools.
|
||
|
||
|
||
## PR-Agent Features
|
||
PR-Agent offers extensive pull request functionalities across various git providers.
|
||
|
||
| | | GitHub | Gitlab | Bitbucket | Azure DevOps |
|
||
|-------|---------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|
|
||
| TOOLS | Review | ✅ | ✅ | ✅ | ✅ |
|
||
| | ⮑ Incremental | ✅ | | | |
|
||
| | ⮑ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ |
|
||
| | Ask | ✅ | ✅ | ✅ | ✅ |
|
||
| | Describe | ✅ | ✅ | ✅ | ✅ |
|
||
| | ⮑ [Inline file summary](https://pr-agent-docs.codium.ai/tools/describe/#inline-file-summary){:target="_blank"} 💎 | ✅ | ✅ | | ✅ |
|
||
| | Improve | ✅ | ✅ | ✅ | ✅ |
|
||
| | ⮑ Extended | ✅ | ✅ | ✅ | ✅ |
|
||
| | [Custom Suggestions](./tools/custom_suggestions.md){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ |
|
||
| | Reflect and Review | ✅ | ✅ | ✅ | ✅ |
|
||
| | Update CHANGELOG.md | ✅ | ✅ | ✅ | ️ |
|
||
| | Find Similar Issue | ✅ | | | ️ |
|
||
| | [Add PR Documentation](./tools/documentation.md){:target="_blank"} 💎 | ✅ | ✅ | | ✅ |
|
||
| | [Generate Custom Labels](./tools/describe.md#handle-custom-labels-from-the-repos-labels-page-💎){:target="_blank"} 💎 | ✅ | ✅ | | ✅ |
|
||
| | [Analyze PR Components](./tools/analyze.md){:target="_blank"} 💎 | ✅ | ✅ | | ✅ |
|
||
| | | | | | ️ |
|
||
| USAGE | CLI | ✅ | ✅ | ✅ | ✅ |
|
||
| | App / webhook | ✅ | ✅ | ✅ | ✅ |
|
||
| | Actions | ✅ | | | ️ |
|
||
| | | | | |
|
||
| CORE | PR compression | ✅ | ✅ | ✅ | ✅ |
|
||
| | Repo language prioritization | ✅ | ✅ | ✅ | ✅ |
|
||
| | Adaptive and token-aware file patch fitting | ✅ | ✅ | ✅ | ✅ |
|
||
| | Multiple models support | ✅ | ✅ | ✅ | ✅ |
|
||
| | Incremental PR review | ✅ | | | |
|
||
| | [Static code analysis](./tools/analyze.md/){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ |
|
||
| | [Multiple configuration options](./usage-guide/configuration_options.md){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ |
|
||
|
||
💎 marks a feature available only in [PR-Agent Pro](https://www.codium.ai/pricing/){:target="_blank"}
|
||
|
||
|
||
## Example Results
|
||
#### [/describe](https://github.com/Codium-ai/pr-agent/pull/530)
|
||
<figure markdown="1">
|
||
{width=512}
|
||
</figure>
|
||
|
||
#### [/review](https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099151)
|
||
<figure markdown="1">
|
||
{width=512}
|
||
</figure>
|
||
|
||
#### [/improve](https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099159)
|
||
<figure markdown="1">
|
||
{width=512}
|
||
</figure>
|
||
|
||
#### [/generate_labels](https://github.com/Codium-ai/pr-agent/pull/530)
|
||
<figure markdown="1">
|
||
{width=300}
|
||
</figure>
|
||
|
||
## How it Works
|
||
|
||
The following diagram illustrates PR-Agent tools and their flow:
|
||
|
||
|
||
|
||
Check out the [PR Compression strategy](core-abilities/index.md) page for more details on how we convert a code diff to a manageable LLM prompt
|
||
|
||
|
||
|
||
## PR-Agent Pro 💎
|
||
|
||
[PR-Agent Pro](https://www.codium.ai/pricing/) is a hosted version of PR-Agent, provided by CodiumAI. It is available for a monthly fee, and provides the following benefits:
|
||
|
||
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 PR-Agent app to your GitHub\GitLab\BitBucket repo.
|
||
2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention.
|
||
3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities.
|
||
4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. It has the following additional tools and features:
|
||
- [**Analyze PR components**](./tools/analyze.md/)
|
||
- [**Custom Code Suggestions**](./tools/custom_suggestions.md/)
|
||
- [**Tests**](./tools/test.md/)
|
||
- [**PR documentation**](./tools/documentation.md/)
|
||
- [**Improve Component**](https://pr-agent-docs.codium.ai/tools/improve_component/)
|
||
- [**Similar code search**](https://pr-agent-docs.codium.ai/tools/similar_code/)
|
||
- [**CI feedback**](./tools/ci_feedback.md/)
|
||
- [**SOC2 compliance check**](./tools/review.md/#soc2-ticket-compliance)
|
||
- [**Custom labels**](./tools/describe.md/#handle-custom-labels-from-the-repos-labels-page)
|
||
- [**Global and wiki configuration**](./usage-guide/configuration_options.md/#wiki-configuration-file)
|
||
|
||
|
||
## Data Privacy
|
||
|
||
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
|
||
|
||
When using PR-Agent Pro 💎, hosted by CodiumAI, we will not store any of your data, nor will we use it for training.
|
||
You will also benefit from an OpenAI account with zero data retention.
|