Shippie

Stage your changes with git add, then invoke Shippie via npx to get an instant AI-powered code review of your staged diff.

git add .
npx shippie review

Create a .env file in your project root and add your OpenAI API key (or configure an alternative provider). Shippie reads this key to authenticate LLM requests.

# .env
OPENAI_API_KEY=your_openai_api_key_here

For persistent use in a project, install Shippie as a dev dependency rather than relying on npx each time.

npm install --save-dev shippie
# or with bun:
bun add --dev shippie

Create a workflow file to run Shippie automatically on every pull request. Store your API key as a GitHub Actions secret.

name: Code Review
on:
  pull_request:
    branches: [main]
jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Run Shippie Review
        run: npx shippie review
        env:
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

To give Shippie access to external tools via MCP — such as browser automation or deployment checks — configure the MCP endpoint in Shippie's configuration as documented in docs/mcp.md.

Create a .shippie rules file in your project root to specify what Shippie should focus on or ignore. This is useful for enforcing team-specific coding standards or excluding generated files.