Configuration File

The configuration file allows you to adjust the various tools and sub-tools used by Qodo Merge.

Configuration file example

An example configuration file can be found in our GitHub repository.

Avoid copying the entire configuration file. Only use the configurations you need.

pr-agent/pr_agent/settings/configuration.toml at main · qodo-ai/pr-agentGitHub

Tip: edit only what you need. Keep your configuration file minimal by only editing the relevant settings.

Avoid copying the entire configuration. This could cause issues when defaults change over time.

How to use the configuration file

The configuration file is a file named .pr_agent.toml, residing at the root of your repository.

Each Qodo Merge tool has its own specific configuration settings.

For example, the review tool uses parameters from the pr_reviewer section of the configuration file:

...
[pr_reviewer] # /review #
# enable/disable features
require_score_review=false
require_tests_review=true
require_estimate_effort_to_review=true
...

If you set in .pr_agent.toml:

[pr_reviewer]
extra_instructions="""\
- instruction a
- instruction b
...
"""

Then you can give a list of extra instructions to the review tool, which it will follow when it runs.

See the Tools Guide for a detailed description of the different tools and their configurations.

Show relevant configurations: Set config.output_relevant_configurations=true to display the relevant configurations for each tool.

This can help with debugging or give you a better understanding of different configuration options.

Local configuration file

How to create a local configuration file

1. Create a file called .pr_agent.toml.

2. Edit any configuration parameter you'd like.

3. Upload the file to the root of the default branch in your repository.

4. The configuration will take effect after being merged into your repository.

Global configuration file

How to create a global configuration file

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

2. In the repository pr-agent-settings, create a file called .pr_agent.toml.

3. Edit any configuration parameter you'd like.

4. Upload the file to the root of the default branch in the repository.

5. The configuration will take effect after being merged into your repository.

The .pr_agent.toml file in this repository will be used as the global configuration for all other repositories in the organization. Local configurations will always override global ones.

Bitbucket organization-level configuration file

In Bitbucket Data Center, you can define global configurations at two levels:

1. Project-level global configuration Create a repository named pr-agent-settings in a specific project. This configuration will apply to all repositories within the same project.

2. Organization-level global configuration Create a dedicated project for global configurations. This will apply to all repositories across all projects in your Bitbucket organization.

Setting up organization-level global configuration:

1. Create a new project named PR_AGENT_SETTINGS.

2. Inside the PR_AGENT_SETTINGS project, create a repository called pr-agent-settings.

3. Add a .pr_agent.toml configuration file to the repository (similar to the global configuration described above).

4. Optionally, you can add an organizational-level global best practices file.

All repositories across your Bitbucket organization will inherit configurations from this file.

Note: If both organization-level and project-level settings are defined, the project-level settings take precedence.

A repository’s local .pr_agent.toml file will always override both global configurations.