2024-06-18 06:40:05 +00: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.
- See the [Tools Guide ](./tools/index.md ) for a detailed description of the different tools.
2024-09-21 17:55:05 +00:00
To search the documentation site using natural language, simply comment `/help "your question"` in a pull request where PR-Agent is installed. PR-Agent will then provide you with an [answer ](https://github.com/Codium-ai/pr-agent/pull/1241#issuecomment-2365259334 ), including relevant documentation links.
2024-06-18 06:40:05 +00:00
## PR-Agent Features
PR-Agent offers extensive pull request functionalities across various git providers.
| | | GitHub | Gitlab | Bitbucket | Azure DevOps |
|-------|-----------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|
2024-07-18 07:58:39 +00:00
| TOOLS | Review | ✅ | ✅ | ✅ | ✅ |
2024-06-18 06:40:05 +00:00
| | ⮑ Incremental | ✅ | | | |
2024-07-18 07:58:39 +00:00
| | ⮑ [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 Prompt ](./tools/custom_prompt.md ){:target="_blank"} 💎 | ✅ | ✅ | ✅ | |
| | Reflect and Review | ✅ | ✅ | ✅ | |
2024-06-18 06:40:05 +00:00
| | Update CHANGELOG.md | ✅ | ✅ | ✅ | ️
| | Find Similar Issue | ✅ | | | ️
2024-07-18 07:58:39 +00:00
| | [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"} 💎 | ✅ | ✅ | | |
2024-06-18 06:40:05 +00:00
| | | | | | ️
2024-07-18 07:58:39 +00:00
| USAGE | CLI | ✅ | ✅ | ✅ | ✅ |
| | App / webhook | ✅ | ✅ | ✅ | ✅ |
2024-06-18 06:40:05 +00:00
| | Actions | ✅ | | | ️
| | | | | |
2024-07-18 07:58:39 +00: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-06-18 06:40:05 +00:00
💎 marks a feature available only in [PR-Agent Pro ](https://www.codium.ai/pricing/ ){:target="_blank"}
## Example Results
< hr >
#### [/describe](https://github.com/Codium-ai/pr-agent/pull/530)
< figure markdown = "1" >
{width=512}
< / figure >
< hr >
#### [/review](https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099151)
< figure markdown = "1" >
{width=512}
< / figure >
< hr >
#### [/improve](https://github.com/Codium-ai/pr-agent/pull/732#issuecomment-1975099159)
< figure markdown = "1" >
{width=512}
< / figure >
< hr >
#### [/generate_labels](https://github.com/Codium-ai/pr-agent/pull/530)
< figure markdown = "1" >
{width=300}
< / figure >
< hr >
## How it Works
The following diagram illustrates PR-Agent tools and their flow:
2024-09-10 06:05:50 +00:00
Check out the [core abilities ](core-abilities/index.md ) page for a comprehensive overview of the variety of core abilities used by PR-Agent.
