Practical overview
When it fits
Use Shippie when you want an agent to review a pull-request diff through GitHub Actions or to produce a local Markdown review of staged changes. Its on-demand pull-request command is another documented route for requesting a review.
Who it is for
- Developers who want automated review comments on pull requests.
- Teams seeking a local review of staged changes before sharing a change.
- Maintainers who want to configure review instructions or connect external tools through MCP.
Documented uses
- Inspect pull-request diffs and post focused review comments.
- Review staged changes locally and save findings to Markdown.
- Flag potential bugs, exposed secrets, inefficient code and unhandled edge cases.
- Extend review behavior with custom instructions, rules files, Agent Skills or external MCP tools.
Requirements & limits
- GitHub Action setup requires a provider API key, a full checkout and pull-request write permission.
- Local mode focuses on staged changes and writes Markdown results beneath
.shippie/review/. - The README lists Anthropic, OpenAI, OpenRouter and Cloudflare Workers AI as provider options.
- MCP connections can give the agent access to external tools such as browser automation, observability and documentation.
- The repository is TypeScript and MIT-licensed.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Set up Shippie as a GitHub Action
Scaffold a pull-request review workflow and configure its documented credentials and permissions.
Before you start
- A GitHub repository and a provider API key stored as a repository secret.
- A full checkout using fetch-depth: 0 and pull-requests: write permission; contents: read is shown in the example workflow.
Steps
Run the command below to scaffold the workflow.
npx shippie initAdd the provider API key as a repository secret.
Confirm the workflow uses a full checkout and grants the documented pull-request and contents permissions.
Expected outcome
A GitHub Actions workflow configured to invoke Shippie on pull requests and post review comments.
Guide limitations
- The README documents the setup but does not establish how a particular repository's workflow will perform.
- The provider API key must be supplied; the example uses Anthropic, while other provider configuration is documented separately.
Review staged changes locally
Run the documented local review workflow on staged Git changes.
Before you start
- Shippie available through npx and staged changes in a Git repository.
Steps
Stage the changes to review.
Run the command below.
npx shippie reviewRead the generated Markdown review under
.shippie/review/.
Expected outcome
A local review of staged changes saved as a Markdown file named `local_*.md`.
Guide limitations
- Local mode reviews staged changes (
git diff --cached), not an unstaged working-tree diff. - The README does not specify local credential setup in this quick-start section.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 9 October 2026
- Original website title
- mattzcarey/shippie · Official homepage title · retained in its source language