2024-03-06 21:52:11 +02:00
# 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.
2024-03-11 09:13:35 +02:00
- See the [Tools Guide ](./tools/index.md ) for a detailed description of the different tools.
2024-03-06 21:52:11 +02:00
2024-03-10 11:55:05 +02:00
## PR-Agent Features
2024-03-06 21:52:11 +02:00
PR-Agent offers extensive pull request functionalities across various git providers.
| | | GitHub | Gitlab | Bitbucket | Azure DevOps |
|-------|---------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|
2024-03-17 13:17:01 +02:00
| TOOLS | Review | ✅ | ✅ | ✅ | ✅ |
| | ⮑ Incremental | ✅ | | | |
| | ⮑ [SOC2 Compliance ](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance ){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ |
| | Ask | ✅ | ✅ | ✅ | ✅ |
| | Describe | ✅ | ✅ | ✅ | ✅ |
2024-04-01 18:56:36 +03:00
| | ⮑ [Inline file summary ](https://pr-agent-docs.codium.ai/tools/describe/#inline-file-summary ){:target="_blank"} 💎 | ✅ | ✅ | | ✅ |
2024-03-17 13:17:01 +02:00
| | Improve | ✅ | ✅ | ✅ | ✅ |
| | ⮑ Extended | ✅ | ✅ | ✅ | ✅ |
| | [Custom Suggestions ](./tools/custom_suggestions.md ){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ |
| | Reflect and Review | ✅ | ✅ | ✅ | ✅ |
| | Update CHANGELOG.md | ✅ | ✅ | ✅ | ️
| | Find Similar Issue | ✅ | | | ️
2024-04-01 18:56:36 +03:00
| | [Add PR Documentation ](./tools/documentation.md ){:target="_blank"} 💎 | ✅ | ✅ | | ✅ |
2024-03-17 13:17:01 +02:00
| | [Generate Custom Labels ](./tools/describe.md#handle-custom-labels-from-the-repos-labels-page-💎 ){:target="_blank"} 💎 | ✅ | ✅ | | ✅ |
2024-04-01 18:56:36 +03:00
| | [Analyze PR Components ](./tools/analyze.md ){:target="_blank"} 💎 | ✅ | ✅ | | ✅ |
2024-03-06 21:52:11 +02:00
| | | | | | ️
2024-03-17 13:17:01 +02:00
| USAGE | CLI | ✅ | ✅ | ✅ | ✅ |
2024-04-01 18:56:36 +03:00
| | App / webhook | ✅ | ✅ | ✅ | ✅ |
2024-03-17 13:17:01 +02:00
| | Actions | ✅ | | | ️
2024-03-06 21:52:11 +02:00
| | | | | |
2024-03-17 13:17:01 +02:00
| 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"} 💎 | ✅ | ✅ | ✅ | ✅ |
2024-03-06 21:52:11 +02:00
💎 marks a feature available only in [PR-Agent Pro ](https://www.codium.ai/pricing/ ){:target="_blank"}
## Example results
2024-03-26 23:00:57 +02:00
#### [/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 >
2024-03-06 21:52:11 +02:00
## How it works
The following diagram illustrates PR-Agent tools and their flow:
2024-03-09 20:47:07 +02:00
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
2024-03-06 21:52:11 +02:00
## 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\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:
2024-03-09 20:47:07 +02:00
- [**Analyze PR components** ](./tools/analyze.md/ )
- [**Custom Code Suggestions** ](./tools/custom_suggestions.md/ )
- [**Tests** ](./tools/test.md/ )
- [**PR documentation** ](./tools/documentation.md/ )
- [**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 )
2024-03-06 21:52:11 +02:00
2024-03-10 11:55:05 +02:00
2024-03-06 21:52:11 +02:00
## 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.
2024-03-10 16:16:25 +02:00
You will also benefit from an OpenAI account with zero data retention.
