Shippie 是一个可扩展的代码审查和 QA 工具，使用大型语言模型在 CI/CD 流程中审查代码，检测安全漏洞、低效代码和潜在 bug。
一分钟了解#
Shippie 是一个基于 AI 的代码审查工具，可集成到 CI/CD 流程中，帮助团队更快地交付高质量代码。它专为开发人员设计，能够自动检测代码中的常见问题，同时支持本地命令行使用。
核心价值：通过 AI 自动化代码审查流程，减少人工代码审查时间，提高代码质量和开发效率。
快速上手#
安装难度：中 - 需要克隆仓库、安装依赖并配置 API 密钥
# 克隆仓库
git clone https://github.com/mattzcarey/shippie.git
cd shippie
# 安装依赖（推荐使用 bun，也可使用 npm 或 pnpm）
bun install
# 配置 API 密钥
cp .env.example .env
# 编辑 .env 文件，替换 YOUR_API_KEY 为你的 OpenAI API 密钥
适合我的场景吗？
- ✅ CI/CD 集成：需要自动化代码审查流程的团队
- ✅ 本地代码检查：希望在提交前快速审查代码的开发者
- ❌ 纯静态代码分析：不依赖 AI 的代码分析场景
- ❌ 离线环境：需要联网才能使用 AI 服务
核心能力#
1. AI 代码审查 - 检测代码问题#
Shippie 使用大型语言模型分析代码，自动识别安全漏洞、性能问题和潜在 bug。 实际价值：减少代码审查时间，提前发现潜在问题，提高软件质量
2. CI/CD 集成 - 自动化工作流#
垂直集成到 CI/CD 管道中，在代码合并前自动执行代码审查。 实际价值：阻止有问题的代码进入主分支，减少后期修复成本
3. 本地命令行工具 - 开发者友好#
可以在本地命令行中运行，审查暂存的文件。 实际价值：在提交前发现问题，减少不必要的提交和 CI 测试失败
4. 规则文件配置 - 自定义审查规则#
支持通过规则文件配置自定义审查规则，最大化工具效果。 实际价值：根据项目特定需求定制审查标准，确保符合团队规范
5. 模型上下文协议(MCP) - 工具扩展#
作为 MCP 客户端，可集成外部工具如浏览器使用、基础设施部署等。 实际价值：扩展审查能力，不仅限于代码本身，还能影响相关系统
技术栈与集成#
开发语言：TypeScript 主要依赖：Bun 运行时（推荐），Node.js（通过 npm），OpenAI API 集成方式：命令行工具 / GitHub Action / MCP 客户端
维护状态#
- 开发活跃度：活跃维护，有贡献者徽章和 Pulse 徽章显示
- 最近更新：使用 release-please 自动化发布版本
- 社区响应：项目有讨论区供用户交流想法和反馈
文档与学习资源#
- 文档质量：基础 - 涵盖设置、配置和开发指南
- 官方文档：仓库中有设置说明、规则文件、AI 提供商配置等文档
- 示例代码：提供演示视频展示工具使用方法