Repository navigation
cr-bot v0.1
cr-bot (v0.1) Release Notes
Welcome to the first release of cr-bot, version 0.1!
cr-bot is a unique command-line application that uses GPT4 to perform automated code reviews on GitHub pull requests or local changes against the main branch.
New Features
- Ability to review GitHub pull requests by simply providing the
owner,repo, andpr_numberas command line arguments. - The
--localoption can be used to review changes on the current branch againstmain. - Users can get help anytime by using the
--helpflag.
Configuration
- The OpenAI API key (
OPENAI_API_KEY) and the GitHub API token (GH_PR_TOKEN) with a 'repo' scope can be configured through the environment variables. The system message (initial prompt) for the completion can be edited before compile time by editingsrc/system-message.txt.
Quickstart
Build it from the source with cargo build --release, and get started! Further Usage and Installation instructions can be found in the README.md file.
Please bear in mind that it's the first release, so there might be some rough edges. I would appreciate your feedback on any bugs or feature requests to improve the tool.
Happy reviewing!