mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-05 21:30:40 +08:00
94 lines
7.4 KiB
Markdown
94 lines
7.4 KiB
Markdown
# Overview
|
||
|
||
Qodo Merge 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 Qodo Merge 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.
|
||
|
||
|
||
## Qodo Merge Docs Smart Search
|
||
|
||
To search the documentation site using natural language:
|
||
|
||
1) Comment `/help "your question"` in either:
|
||
|
||
- A pull request where Qodo Merge is installed
|
||
- A [PR Chat](https://qodo-merge-docs.qodo.ai/chrome-extension/features/#pr-chat)
|
||
|
||
2) Qodo Merge will respond with an [answer](https://github.com/Codium-ai/pr-agent/pull/1241#issuecomment-2365259334) that includes relevant documentation links.
|
||
|
||
|
||
## Qodo Merge Features
|
||
|
||
Qodo Merge offers extensive pull request functionalities across various git providers.
|
||
|
||
| | | GitHub | Gitlab | Bitbucket | Azure DevOps |
|
||
|-------|-----------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|
|
||
| TOOLS | Review | ✅ | ✅ | ✅ | ✅ |
|
||
| | ⮑ Incremental | ✅ | | | |
|
||
| | ⮑ [SOC2 Compliance](https://qodo-merge-docs.qodo.ai/tools/review/#soc2-ticket-compliance){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ |
|
||
| | Ask | ✅ | ✅ | ✅ | ✅ |
|
||
| | Describe | ✅ | ✅ | ✅ | ✅ |
|
||
| | ⮑ [Inline file summary](https://qodo-merge-docs.qodo.ai/tools/describe/#inline-file-summary){:target="_blank"} 💎 | ✅ | ✅ | | ✅ |
|
||
| | Improve | ✅ | ✅ | ✅ | ✅ |
|
||
| | ⮑ Extended | ✅ | ✅ | ✅ | ✅ |
|
||
| | [Custom Prompt](./tools/custom_prompt.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 [Qodo Merge 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 Qodo Merge 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 |