Configure Using .pr_agent.toml File

The configuration file enables you to customize how Qodo behaves during code reviews. Learn more about the Qodo configuration mechanisms here.

It controls:

  • Review behavior

  • Feedback presentation

  • Automation

  • Feature-level settings

Qodo reads configuration from a file named:

.pr_agent.toml

The file is organized into sections (TOML tables). Each section controls a specific aspect of Qodo’s behavior during code review.

When a setting is defined in multiple locations, the highest-precedence configuration takes effect.

Example configuration

⚠️ Select ONLY ONE git provider below.
# Do not include multiple provider sections in the same configuration file.

[github_app][gitlab][bitbucket_app][bitbucket_server][azure_devops_server]
pr_commands = [
    "/agentic_describe",
    "/agentic_review"
]

[review_agent] 
# "both" mode is too noisy, keep in "summary" mode in this repo
comments_location_policy = "both" 

# severity threshold rank for inline comments: 
# 3=action_required, 
# 2=remediation_recommended, 
# 1=informational. 
# Only findings with rank >= threshold will be published inline
inline_comments_severity_threshold = 3

# Extra prompt for usecase to be added as instruction for the agent 
issues_user_guidelines = ""
compliance_user_guidelines = ""

Configuration using pr_agent.toml

File-based configuration can be defined at repository, project/group, or organization levels. Each level may have platform-specific setup patterns.

Repository Level

Repository Root Configuration

circle-check

Create a local configuration file.

  1. Create a file named .pr_agent.toml.

  2. Add the desired configuration settings.

  3. Commit the file to the root of the default branch.

The configuration takes effect for pull requests created after the change is merged.

This configuration applies only to thit repository.

Wiki configuration

circle-check

Create a wiki configuration.

  1. Enable the repository wiki. Learn more here.

  2. Create a new wiki page named .pr_agent.toml.

  3. Ensure the page begins with a fenced TOML block.

  4. Add any configuration parameters you need.

  5. Save the page.

Changes take effect immediately and do not require a repository commit.

Project or group-level configuration

circle-check

Create a project or group configuration.

  1. Create a repository named pr-agent-settings within:

    • A project (Bitbucket, Azure DevOps), or

    • A group or subgroup (GitLab).

  2. Add a .pr_agent.toml file to the root of the default branch.

  3. Define the configuration settings.

This configuration applies to all repositories directly under that project or group.

circle-info

GitLab: For repositories nested in multiple subgroups, Qodo looks only one level up for a pr-agent-settings repository.

Organization-level configuration

Cloud platforms

circle-check

Create a global configuration file.

  1. Create a repository named pr-agent-settings in your organization.

  2. Add a .pr_agent.toml file to the root of the default branch.

  3. Define organization-wide defaults.

The configuration:

  • Takes effect for pull requests created after the change is merged.

  • Applies to all repositories in the organization unless overridden by a local or wiki configuration.

Enterprise environments

circle-check

All repositories in the organization inherit settings from this configuration.

Create organization-level configuration.

  1. Create a project named:

    • PR_AGENT_SETTINGS with project key PR_AGENT_SETTINGS (Bitbucket Data Center), or

    • pr-agent-settings (Azure DevOps).

  2. Inside that project, create a repository named pr-agent-settings.

  3. Add a .pr_agent.toml file to the repository.

If both organization-level and project-level configurations exist, project-level settings take precedence. A repository’s local configuration always overrides both.

Last updated