xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-15 18:20:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update Configuration.md

Browse Source
This commit is contained in:
mrT23
2023-08-04 12:13:04 +03:00
parent 26b008565b
commit bd07a0cd7f
2 changed files with 28 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
CONFIGURATION.md
View File

@ -1,9 +1,31 @@
## Configuration
The different tools and sub-tools used by CodiumAI pr-agent are adjustable via the configuration file: `/pr-agent/settings/configuration.toml`.
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.
To edit the configuration of any tool, just add `--config_path=<value>` to you command.
For example if you want to edit online the `pr_reviewer` configurations, you can run:
For example if you want to edit online `pr_reviewer` configurations, you can run:
```
/review --pr_reviewer.extra_instructions="focus on the file xyz" --pr_reviewer.require_score_review=false ...
```