Shippie 🚢 (formerly Code Review GPT)

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

https://github.com/mattzcarey/shippie/assets/77928207/92029baf-f691-465f-8d15-e1363fcb808e

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.

Additional Documentation

• Rules Files - How to use rules files to get the most out of Shippie
• AI Provider Configuration - Configure different AI providers
• Action Options - GitHub Action configuration options
• Model Context Protocol (MCP) - Give Shippie access to external tools

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.

Star History ⭐️

Changelog

0.18.0 (2025-06-08)

Features

• sub agent (#446) (b1b2651)
• testing: scenario-based E2E testing framework (#450) (1e423be)

0.17.1 (2025-06-02)

Bug Fixes

• re-add support for azure openai (#444) (2c850b5)

0.17.0 (2025-05-28)

Features

• support for custom file endings (#442) (8198fa3)

0.16.0 (2025-05-25)

Features

• prompt sizes: Update model info (#438) (bc08b6d)

0.15.0 (2025-05-23)

Features

• use context from rules (#435) (066cd64)

0.14.3 (2025-05-22)

Bug Fixes

• action.yml: action hates a frozen lockfile (#431) (3d699a6)

0.14.2 (2025-05-21)

Bug Fixes

• cicd: action.yml tested on pull request (#428) (ae53718)

0.14.1 (2025-05-21)

Bug Fixes

• base url default to empty string in action.yml (#426) (36653b7)

0.14.0 (2025-05-12)

Features

• cli: move to tsup (#421) (4a55214)

0.13.0 (2025-05-12)

Features

• some basic telemetry data (#416) (10676a8)
• thinking tool (#418) (8aa4a5e)
• tools: mcp client and client manager (#419) (3ad39b2)

0.12.2 (2025-05-12)

Bug Fixes

• action: add debug argument (#411) (e24ed7f)

0.12.1 (2025-05-12)

Bug Fixes

• cicd: npm token (#414) (a72f00d)
• review: use node fs for readFile tool (#412) (75f083f)

0.12.0 (2025-04-30)

Features

• azure ai provider (#409) (69e9d43)

0.11.0 (2025-04-29)

Features

• add usage stats (#407) (f075aa9)

0.10.0 (2025-04-28)

Features

• rename to shippie (#405) (5abf3f2)

0.9.0 (2025-04-28)

Features

• check pr title workflow (#403) (c7edf3b)

0.8.0 (2025-02-23)

Features

• Add C lang (#390) (7cb838f)

Bug Fixes

• annoying spelling (5d0c096)

0.7.0 (2025-02-20)

Features

• add support for arbitrary OpenAI compatible APIs (#383) (4bf0bda)

0.6.0 (2025-01-28)

Features

• azure: Add support for azure open Ai (#377) (989c26a)
• use picocolors and tinyglobby and biome check fix (#375) (760e830)

Bug Fixes

• release-package workflow (e7cb470)

0.5.0 (2025-01-14)

Features

• update review prompt to focus on negative aspects of code (#371) (66a6208)

Bug Fixes

• escape file names in git diff commands for better compatibility (#370) (c99cd02)

0.4.0 (2025-01-12)

Features

• use bun for bundling (159e2db)

0.3.0 (2025-01-12)

Features

• comment with no feedback (c8b639a)

Bug Fixes

• lock file (d900fef)

0.2.0 (2025-01-12)

Features

• Add support for o1-preview model (#353) (d0d8f7d)
• move to bun and structure output (#364) (c042495)

Bug Fixes

• action.yml (#365) (286aa0d)
• change gpt model naming (#362) (263dc3d)

0.1.0 (2023-08-16)

Features

• add demo prompt for code snippet (3bf76bf)
• docs on how to set up gitlab access token (a9643f2)
• make review function return feedback (c58fcee)
• pass OpenAIApiKey as a parameter in lambdas instead of taking from process.env (ba47456)

Bug Fixes

• do not add file to prompt if only removed lines (#174) (a33f49a)

0.0.34 (2023-08-07)

Features

• add back filter files in review (3aee4f7)
• Added PHP to languageMap (#110) (0de1790)
• authjs following nextjs 13 structure (2893313)
• authjs github login (7f02c16)
• automated release pipeline (#102) (1475c7d)
• bump package (4ec97a1)
• bump package (793ffa6)
• bump package (1925493)
• bump package (2e8b916)
• bump package (7b5d77a)
• bump version (f656a83)
• ci commenting (#2) (056b0f6)
• ci test (#41) (4734ef1)
• configure option (#14) (937fcd0)
• create some abstraction in llms (0a64bc4)
• debug logging and logging logic in ci, local and debug mode (#77) (a154cab)
• esbuild (026e134)
• feedback: limit the number of feedbacks to 5 feedbacks at most (b52441d)
• gh action (0be4bf1)
• gh action (6458144)
• header styling and linking to the repo (e8a1085)
• init (98990cb)
• keywords (47e804b)
• mask apiKey in prompt and add async functions (cc95720)
• move git commands in common folder out of review (b4bd034)
• new version (554f02a)
• nextjs app with sst (44d8f57)
• package bump (fce63cd)
• package push (b1b8703)
• published to npm (614e3c6)
• remove dead cod and refactor (506ced5)
• remove errors for no supported files (347821e)
• signoff (#6) (37c5daf)
• split up prompts (4e26f23)
• test: add test command and implement code snippet generation (1669305)
• update comments (#9) (c13c3fc)
• update readme (21bee1b)
• use tslog for logging (4d287ff)

Bug Fixes

• add id to release please ci step (29345e7)
• brackets in json (58e4b6a)
• bump package (db101e0)
• do not send changedLines in prompt (96475b3)
• exit when there is no file to review (81097f1)
• explicit exit code and return in review index (9bb8140)
• gitlab git command (4f19728)
• gitlab support improvements (#97) (a5c7d6b)
• log type (2a18fa6)
• max prompt length per model (#33) (fc45818)
• openai_api_key (915f806)
• permissions (91979c9)
• releases_created (#106) (4d18dbe)
• remove console.log (e28d1e5)
• remove debug workflows (c0a5c4b)
• remove unnecessary async in function (fa9db17)
• separate flags for review and configure (5cb8b69)
• use same format for all command and options formats (3971793)
• version number (41a723d)

Miscellaneous Chores

• update description (#118) (9dca0a0)