Files
pr-agent/CONFIGURATION.md

35 lines
1.3 KiB
Markdown
Raw Normal View History

2023-07-16 14:59:40 +03:00
## Configuration
2023-08-04 12:13:04 +03:00
The different tools and sub-tools used by CodiumAI PR-Agent are adjustable via the configuration file: `/pr-agent/settings/configuration.toml`.
### CLI
When running from source (CLI), your local configuration file will be used.
Example for invoking the 'review' tools via the CLI:
```
python cli.py --pr-url=<pr_url> review
```
In addition to general configurations, The 'review' tool will use parameters from the `[pr_reviewer]` section. Every tool has a dedicated section in the configuration file
Note that you can print results locally, without publishing them, by setting in `configuration.toml`:
```
[config]
publish_output=true
verbosity_level=2
```
This is useful for debugging or experimenting with the different tools.
### Working from pre-built repo (GitHub Action/GitHub App/Docker/...)
When running PR-Agent from a pre-built repo, the default configuration file will be loaded.
2023-07-16 14:59:40 +03:00
2023-07-30 22:01:14 +03:00
To edit the configuration of any tool, just add `--config_path=<value>` to you command.
2023-08-04 12:13:04 +03:00
For example if you want to edit online `pr_reviewer` configurations, you can run:
2023-07-16 14:59:40 +03:00
```
2023-07-30 22:16:56 +03:00
/review --pr_reviewer.extra_instructions="focus on the file xyz" --pr_reviewer.require_score_review=false ...
2023-07-16 14:59:40 +03:00
```
2023-07-30 22:01:14 +03:00
2023-07-30 22:04:59 +03:00
Any configuration value in `configuration.toml` file can be similarly edited.
2023-07-30 22:01:14 +03:00