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

Merge remote-tracking branch 'origin/main'

Browse Source
This commit is contained in:
Ori Kotek
2023-08-10 15:16:10 +03:00
parent 4a47b78a90 17ed050ca7
commit 0bb8ab70a4
2 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -97,12 +97,12 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review pull
| | Incremental PR Review | :white_check_mark: | | | | | Incremental PR Review | :white_check_mark: | | |
Examples for invoking the different tools via the CLI: Examples for invoking the different tools via the CLI:
- **Review**: python cli.py --pr-url=<pr_url> review - **Review**: python cli.py --pr_url=<pr_url> review
- **Describe**: python cli.py --pr-url=<pr_url> describe - **Describe**: python cli.py --pr_url=<pr_url> describe
- **Improve**: python cli.py --pr-url=<pr_url> improve - **Improve**: python cli.py --pr_url=<pr_url> improve
- **Ask**: python cli.py --pr-url=<pr_url> ask "Write me a poem about this PR" - **Ask**: python cli.py --pr_url=<pr_url> ask "Write me a poem about this PR"
- **Reflect**: python cli.py --pr-url=<pr_url> reflect - **Reflect**: python cli.py --pr_url=<pr_url> reflect
- **Update Changelog**: python cli.py --pr-url=<pr_url> update_changelog - **Update Changelog**: python cli.py --pr_url=<pr_url> update_changelog
"<pr_url>" is the url of the relevant PR (for example: https://github.com/Codium-ai/pr-agent/pull/50). "<pr_url>" is the url of the relevant PR (for example: https://github.com/Codium-ai/pr-agent/pull/50).

14
pr_agent/cli.py
View File

@ -10,13 +10,13 @@ from pr_agent.config_loader import get_settings
def run(inargs=None): def run(inargs=None):
parser = argparse.ArgumentParser(description='AI based pull request analyzer', usage= parser = argparse.ArgumentParser(description='AI based pull request analyzer', usage=
"""\ """\
Usage: cli.py --pr-url <URL on supported git hosting service> <command> [<args>]. Usage: cli.py --pr-url=<URL on supported git hosting service> <command> [<args>].
For example: For example:
- cli.py --pr-url=... review - cli.py --pr_url=... review
- cli.py --pr-url=... describe - cli.py --pr_url=... describe
- cli.py --pr-url=... improve - cli.py --pr_url=... improve
- cli.py --pr-url=... ask "write me a poem about this PR" - cli.py --pr_url=... ask "write me a poem about this PR"
- cli.py --pr-url=... reflect - cli.py --pr_url=... reflect
Supported commands: Supported commands:
review / review_pr - Add a review that includes a summary of the PR and specific suggestions for improvement. review / review_pr - Add a review that includes a summary of the PR and specific suggestions for improvement.
@ -27,7 +27,7 @@ reflect - Ask the PR author questions about the PR.
update_changelog - Update the changelog based on the PR's contents. update_changelog - Update the changelog based on the PR's contents.
To edit any configuration parameter from 'configuration.toml', just add -config_path=<value>. To edit any configuration parameter from 'configuration.toml', just add -config_path=<value>.
For example: '- cli.py --pr-url=... review --pr_reviewer.extra_instructions="focus on the file: ..."' For example: 'python cli.py --pr_url=... review --pr_reviewer.extra_instructions="focus on the file: ..."'
""") """)
parser.add_argument('--pr_url', type=str, help='The URL of the PR to review', required=True) parser.add_argument('--pr_url', type=str, help='The URL of the PR to review', required=True)
parser.add_argument('command', type=str, help='The', choices=commands, default='review') parser.add_argument('command', type=str, help='The', choices=commands, default='review')