pr-agent/docs/docs/index.md

7.4 KiB
Raw Blame History

Overview

CodiumAI PR-Agent is an open-source tool to help efficiently review and handle pull requests.

  • See the Installation Guide for instructions on installing and running the tool on different git platforms.

  • See the Usage Guide 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 for a detailed description of the different tools.

To search the documentation site using natural language:

  1. Comment /help "your question" in either:

    • A pull request where PR-Agent is installed
    • A PR Chat
  2. PR-Agent will respond with an answer that includes relevant documentation links.

PR-Agent Features

PR-Agent offers extensive pull request functionalities across various git providers.

GitHub Gitlab Bitbucket Azure DevOps
TOOLS Review
⮑ Incremental
SOC2 Compliance{:target="_blank"} 💎
Ask
Describe
Inline file summary{:target="_blank"} 💎
Improve
⮑ Extended
Custom Prompt{:target="_blank"} 💎
Reflect and Review
Update CHANGELOG.md
Find Similar Issue
Add PR Documentation{:target="_blank"} 💎
Generate Custom Labels{:target="_blank"} 💎
Analyze PR Components{: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{:target="_blank"} 💎
Multiple configuration options{:target="_blank"} 💎

💎 marks a feature available only in PR-Agent Pro{:target="_blank"}

Example Results


/describe

![/describe](https://www.codium.ai/images/pr_agent/describe_new_short_main.png){width=512}

/review

![/review](https://www.codium.ai/images/pr_agent/review_new_short_main.png){width=512}

/improve

![/improve](https://www.codium.ai/images/pr_agent/improve_new_short_main.png){width=512}

/generate_labels

![/generate_labels](https://www.codium.ai/images/pr_agent/geneare_custom_labels_main_short.png){width=300}

How it Works

The following diagram illustrates PR-Agent tools and their flow:

PR-Agent Tools

Check out the core abilities page for a comprehensive overview of the variety of core abilities used by PR-Agent.