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

Merge pull request #340 from Codium-ai/tr/readme

Browse Source 
Update Documentation and CLI Execution Method
This commit is contained in:
mrT23
2023-09-29 16:43:10 +03:00
committed by GitHub
parent f96c6cbc95 2003b6915b
commit 8b033ccc94
3 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
INSTALL.md
View File

@ -89,10 +89,10 @@ chmod 600 pr_agent/settings/.secrets.toml
```
export PYTHONPATH=[$PYTHONPATH:]<PATH to pr_agent folder>
python pr_agent/cli.py --pr_url <pr_url> /review
python pr_agent/cli.py --pr_url <pr_url> /ask <your question>
python pr_agent/cli.py --pr_url <pr_url> /describe
python pr_agent/cli.py --pr_url <pr_url> /improve
python3 -m pr_agent.cli --pr_url <pr_url> /review
python3 -m pr_agent.cli --pr_url <pr_url> /ask <your question>
python3 -m pr_agent.cli --pr_url <pr_url> /describe
python3 -m pr_agent.cli --pr_url <pr_url> /improve
```
---

2
docs/IMPROVE.md
View File

@ -1,4 +1,4 @@
# Describe Tool
# Improve Tool
The `improve` tool scans the PR code changes, and automatically generate committable suggestions for improving the PR code.
It can be invoked manually by commenting on any PR:

2
docs/REVIEW.md
View File

@ -1,4 +1,4 @@
# Describe Tool
# Review Tool
The `review` tool scans the PR code changes, and automatically generates a PR review.
It can be invoked manually by commenting on any PR: