Skip to content

Code Review GPT

Actions
Reviews the staged files with a GPT model from OpenAI
v0.14.0
Latest
Star (2.1K)

Shippie 🚢 (formerly Code Review GPT)

NPM Contributors Pulse License Twitter

Helps you ship faster

Shippie uses Large Language Models to review code in your CI/CD pipeline. It should pick up on common issues such as:

  • Exposed secrets
  • Slow or inefficient code
  • Potential bugs or unhandled edge cases

It can also be run locally in your command line to review staged files.

npx shippie review

Demo

code-review-gpt-3.mp4

Ethos 💭

  • Beautiful CLI tool written in typescript and bun
  • Vertically integrated into your CI/CD pipeline
  • Functions as a human code reviewer, using a small set of optimised tools
  • Acts as a Model Context Protocol (MCP) client for integration with external tools such as browser use, infrastructure deployments, observability monitoring.

Setup Instructions 💫

See the setup instructions for more docs on how to set up shippie in your CI/CD pipeline and use it locally.

Development 🔧

  1. Clone the repository:

    git clone https://github.com/mattzcarey/shippie.git
    cd shippie
  2. Install dependencies (we use bun but you can use npm or pnpm if you prefer):

    bun i
  3. Set up the API key:

    • Rename the .env.example file to .env.
    • Open the .env file and replace YOUR_API_KEY with your actual OPENAI API key.
  4. Run the application:

bun start

See the package.json file for all the npm commands you can run.

  1. Make a PR 🎉

We use release-please on this project. If you want to create a new release from your PR, please make sure your PR title follows the Conventional Commits format. The release-please bot will automatically create a new release for you when your PR is merged.

  • fix: which represents bug fixes, and correlates to a patch version.
  • feat: which represents a new feature, and correlates to a SemVer minor.
  • feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a major version.

Contributors 🙏

Thanks to our wonderful contributors!

Roadmap 🌏

Have a look at the discussion tab for the latest chat and ideas. I am actively working on the items in todo.md.

Sponsors ❤️

quivr logo aleios logo

Star History ⭐️

Star History Chart

Code Review GPT is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Reviews the staged files with a GPT model from OpenAI
v0.14.0
Latest

Code Review GPT is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.