Skip to main content

CLI tool that reviews your git changes with GPT-3.5 and GPT-4

Project description

Let your code changes get reviewed by AI with codereview-agi

Build Publish

ezgif-5-956a1609ab

Get review suggestions to changes in your git working directory or to any committed changes in your current branch against a target branch and let these suggestions get applied to your code with an informative commit message.

✨ Features

  • Get feedback and suggestions with the corresponding line numbers to your git changes in your terminal
  • Let your current working directory get reviewed (staged and unstaged changes)
  • Let all commits of your current branch get reviewed against any specific target branch
  • Let AI-generated review suggestions get applied to your code
  • Let a commit message get generated for your current changes

[!NOTE] Review suggestions will only be applied to files without unstaged changes, so that nothing is overridden.

🚀 Usage

  • rgpt review: Reviews all changes in your working directory and applies review suggestions to related files autonomously.
  • rgpt review --readonly: Reviews all changes without applying the suggestions to the code.
  • rgpt review --guided: User needs to confirm review process for each file. Useful if not all files should get reviewed.
  • rgpt review --target $BRANCH: Reviews all committed changes in your current branch compared to $BRANCH.
  • rgpt review --gpt4: Use GPT-4 model (default is GPT-3.5).
  • rgpt commit: Generates a commit message for your staged changes.

📋 Requirements

  • Python >= 3.8

🔧 Installation

Create your personal OpenAI Api key and add it as $OPENAI_API_KEY to your environment with:

export OPENAI_API_KEY=<YOUR_API_KEY>

Install with pipx:

pipx install gitreview-gpt

[!NOTE] It is recommended to use pipx for installation, nonetheless it is also possible to use pip.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gitreview_gpt-0.1.4.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gitreview_gpt-0.1.4-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file gitreview_gpt-0.1.4.tar.gz.

File metadata

  • Download URL: gitreview_gpt-0.1.4.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.8.17 Linux/5.15.0-1041-azure

File hashes

Hashes for gitreview_gpt-0.1.4.tar.gz
Algorithm Hash digest
SHA256 3216fa1bc7bb8a8f66e32b27e2adb8b168808d8bb6e2729db2c9725bde4cd6e0
MD5 11cbff55ee78236261144702091c5e11
BLAKE2b-256 d2dfccd0a49cca2efe52875c14aeb2a2d649070e84d2874e9ebc2a74bdab117c

See more details on using hashes here.

File details

Details for the file gitreview_gpt-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: gitreview_gpt-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 14.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.8.17 Linux/5.15.0-1041-azure

File hashes

Hashes for gitreview_gpt-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a86331c98159aab209cf61fbe56bc4c0d570f0c0542abb07a57de9b90731c3ba
MD5 ae4d0de1022d032fbdc2a46868f087b9
BLAKE2b-256 741b69fa095afb4221bf29c45f86beb28dedac12f60551c8bbf0a36e5b7d2830

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page