rjmacarthy/gpt-code-reviewer

Use ChatGPT to conduct code reviews on your pull requests.

gpt-code-reviewer

gpt-code-reviewer is a Python script that assists you with code reviews using OpenAI's GPT-3.5 language model. It interacts with users through a command line interface and GitHub API to retrieve code for review.

Requirements

The script requires access to a GitHub account and an OpenAI API key.

Set environment variables:

GITHUB_TOKEN - optional for authentication

OPENAI_API_KEY - required to access gpt

Usage

Clone the repository and navigate to its directory in your terminal. Then, run the following command:

cp config.yaml.example config.yaml

Edit config.yaml to suit your needs.

Run this command to start the application and chat with GPT about your pull requests.

python chat.py

The script will prompt you to select a repository and pull request to review. You will then be prompted to enter 'r' to review the code, 'q' to quit, 'h' for help, and 'n' to review a different pull request.

The language model will provide suggestions and feedback based on your input, and you can continue to review the code until you are finished.

Transcripts of the conversation will be saved as a markdown file for reference.

API

You can also host gpt-code-reviewer as an api using python api.py, see api.py for the list of routes.

SudoLang

You can run a SudoLang version of this at https://github.com/rjmacarthy/pseudo

License

This script is licensed under the MIT License. See the LICENSE file for details.