gpt-review  by microsoft

CLI tool for code review and question answering using GPT models

created 2 years ago
288 stars

Top 92.1% on sourcepulse

GitHubView on GitHub
1 Expert Loves This Project
Project Summary

This Python CLI and GitHub Action leverages OpenAI or Azure OpenAI models to automate pull request reviews, generate commit messages, and answer questions about code or documents. It targets developers and teams seeking to enhance code quality and streamline workflows by integrating AI-powered assistance directly into their development process.

How It Works

The tool acts as an interface to large language models, allowing users to interact with them via a command-line interface or a GitHub Action. It supports direct API calls to OpenAI or connections to Azure OpenAI endpoints, with configurable parameters for model behavior such as max_tokens and temperature. For pull request reviews, it analyzes diffs and provides feedback, aiming to catch potential issues and suggest improvements.

Quick Start & Requirements

  • Install via pip: pip install gpt-review
  • Requires OpenAI API key (OPENAI_API_KEY) or Azure OpenAI credentials (AZURE_OPENAI_API_URL, AZURE_OPENAI_API_KEY).
  • Azure Key Vault integration is supported via AZURE_KEY_VAULT_URL.
  • GitHub Action requires a GITHUB_ACCESS_TOKEN.
  • Official documentation: Not explicitly linked, but commands include --help flags.

Highlighted Details

  • CLI commands for asking questions, reviewing PRs, and generating commit messages.
  • Supports file uploads for context-aware questions.
  • Configurable LLM parameters for fine-tuning responses.
  • GitHub Action integration for automated PR analysis.

Maintenance & Community

  • Developed by Microsoft.
  • No explicit community links (Discord, Slack) or roadmap are provided in the README.

Licensing & Compatibility

  • The README does not specify a license.

Limitations & Caveats

The project's license is not specified, which may impact commercial use or integration into closed-source projects. There is no mention of supported Python versions beyond the installation command.

Health Check
Last commit

8 months ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
0
Star History
8 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.