pr-agent/docs/docs/index.md

Overview

PR-Agent is an open-source tool to help efficiently review and handle pull requests. Qodo Merge is a hosted version of PR-Agent, designed for companies and teams that require additional features and capabilities

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

• See the Usage Guide for instructions on running 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.

• See the Video Tutorials for practical demonstrations on how to use the tools.

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

2. The bot will respond with an answer that includes relevant documentation links.

Features

PR-Agent and Qodo Merge offers extensive pull request functionalities across various git providers:

		GitHub	GitLab	Bitbucket	Azure DevOps
TOOLS	Review	✅	✅	✅	✅
	Describe	✅	✅	✅	✅
	Improve	✅	✅	✅	✅
	Ask	✅	✅	✅	✅
	⮑ Ask on code lines	✅	✅
	Update CHANGELOG	✅	✅	✅	✅
	Help Docs	✅	✅	✅
	Ticket Context 💎	✅	✅	✅
	Utilizing Best Practices 💎	✅	✅	✅
	PR Chat 💎	✅
	Suggestion Tracking 💎	✅	✅
	CI Feedback 💎	✅
	PR Documentation 💎	✅	✅
	Custom Labels 💎	✅	✅
	Analyze 💎	✅	✅
	Similar Code 💎	✅
	Custom Prompt 💎	✅	✅	✅
	Test 💎	✅	✅
	Implement 💎	✅	✅	✅
	Scan Repo Discussions 💎	✅
	Auto-Approve 💎	✅	✅	✅
USAGE	CLI	✅	✅	✅	✅
	App / webhook	✅	✅	✅	✅
	Tagging bot	✅
	Actions	✅	✅	✅	✅
CORE	PR compression	✅	✅	✅	✅
	Adaptive and token-aware file patch fitting	✅	✅	✅	✅
	Multiple models support	✅	✅	✅	✅
	Local and global metadata	✅	✅	✅	✅
	Dynamic context	✅	✅	✅	✅
	Self reflection	✅	✅	✅	✅
	Static code analysis 💎	✅	✅
	Global and wiki configurations 💎	✅	✅	✅
	PR interactive actions 💎	✅	✅
	Impact Evaluation 💎	✅	✅
	Code Validation 💎	✅	✅	✅	✅
	Auto Best Practices 💎	✅
!!! note "💎 means Qodo Merge only"
All along the documentation, 💎 marks a feature available only in Qodo Merge{:target="_blank"}, and not in the open-source version.

Example Results

---

/describe

{width=512}

---

/review

{width=512}

---

/improve

{width=512}

---

/generate_labels

{width=300}

---

How it Works

The following diagram illustrates Qodo Merge tools and their flow:

Check out the PR Compression strategy page for more details on how we convert a code diff to a manageable LLM prompt