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

tools

Browse Source
This commit is contained in:
mrT23
2023-11-06 08:10:04 +02:00
parent c917e48098
commit bb2760ae41
1 changed files with 5 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
INSTALL.md
View File

@ -29,7 +29,9 @@ There are several ways to use PR-Agent:
### Use Docker image (no installation required) ### Use Docker image (no installation required)
To request a review for a PR, or ask a question about a PR, you can run directly from the Docker image. Here's how: A list of the relevant tools can be found in the [tools guide](./docs/TOOLS_GUIDE.md).
To invoke a tool (for example `review`), you can run directly from the Docker image. Here's how:
- For GitHub: - For GitHub:
``` ```
@ -55,22 +57,15 @@ For other git providers, update CONFIG.GIT_PROVIDER accordingly, and check the `
--- ---
Similarly, to ask a question about a PR, run the following command:
```
docker run --rm -it -e OPENAI.KEY=<your key> -e GITHUB.USER_TOKEN=<your token> codiumai/pr-agent --pr_url <pr_url> ask "<your question>"
```
A list of the relevant tools can be found in the [tools guide](./docs/TOOLS_GUIDE.md). If you want to ensure you're running a specific version of the Docker image, consider using the image's digest:
Note: If you want to ensure you're running a specific version of the Docker image, consider using the image's digest:
```bash ```bash
docker run --rm -it -e OPENAI.KEY=<your key> -e GITHUB.USER_TOKEN=<your token> codiumai/pr-agent@sha256:71b5ee15df59c745d352d84752d01561ba64b6d51327f97d46152f0c58a5f678 --pr_url <pr_url> review docker run --rm -it -e OPENAI.KEY=<your key> -e GITHUB.USER_TOKEN=<your token> codiumai/pr-agent@sha256:71b5ee15df59c745d352d84752d01561ba64b6d51327f97d46152f0c58a5f678 --pr_url <pr_url> review
``` ```
Or you can run a [specific released versions](./RELEASE_NOTES.md) of pr-agent, for example: Or you can run a [specific released versions](./RELEASE_NOTES.md) of pr-agent, for example:
``` ```
codiumai/pr-agent@v0.8 codiumai/pr-agent@v0.9
``` ```
--- ---