公关伙伴
您友好的公关评论伙伴!一个CLI工具,可帮助您使用模型上下文协议(MCP)签出GitHub拉取请求并获得AI驱动的代码审查。
特性
- 🔍 浏览和查看PR:直接从您的终端列出和结账拉取请求
- 🤖 AI代码审查:获得具有可配置深度级别的智能代码审查
- 💬 PR评论:直接添加评论以拉取请求
- 📝 在线评论:提交带有内联代码注释的评论
- 📊 差异分析:使用VS Code中的自动文件打开查看和分析PR差异
- 🎯 智能评论类别:审查涵盖了错误、安全性、性能、代码质量和建议
先决条件
- Node.js(v18或更高版本)
- Git
- 可以访问您要查看的存储库的GitHub帐户
- VS代码(可选,用于自动打开文件)
安装
- 克隆存储库:
git clone
cd pr-buddy- 安装依赖项:
npm install- 构建项目:
npm run build- 创建一个
.env根目录中的文件:
ANTHROPIC_API_KEY=your_api_key_here用法
发展模式
npm run dev生产模式
npm start或者全局安装并用作命令:
npm install -g .
pr-buddy运作原理
- 连接到GitHub MCP:通过模型上下文协议建立与GitHub的连接
- 获取PR:列出当前存储库的所有打开的拉取请求
- 结账处:查看所选PR的分支
- 分析变化:获取差异和更改的文件
- 查看选项:
- 获得AI代码审查(低/中/高详细程度) - 在PR中添加评论 - 提交带有内联注释的手动审核 - AI审核+自动发布到PR
审查深度级别
- 低:快速扫描,仅关注关键问题
- 中等:涵盖重要问题的平衡审查(默认)
- 高:对所有方面进行全面、详细的分析
评论类别
人工智能审查提供了以下类别的反馈:
- 🐛 潜在Bug:逻辑错误和潜在的运行时问题
- 🔒 安全问题:安全漏洞和最佳做法
- ⚡ 演出:性能优化和瓶颈
- 📝 代码质量:可维护性、可读性和最佳实践
- ✨ 建议:改进和替代办法
- ✅ 什么是好的:编写良好的代码的亮点
配置
该工具寻找 .env 安装目录中的文件。所需的环境变量:
ANTHROPIC_API_KEY:人工智能评论的人类API密钥
项目结构
src/
├── index.ts # Main CLI entry point
├── mcp-client.ts # GitHub MCP client
├── git-helper.ts # Git operations wrapper
├── reviewer.ts # AI code review logic
├── explainer.ts # Review file generation
└── diff-parser.ts # Diff parsing utilities脚本
npm run build-将TypeScript编译为JavaScriptnpm run dev-使用tsx在开发模式下运行npm start-运行编译后的JavaScript
许可证
麻省理工学院
贡献
欢迎投稿!请随时提交拉取请求。
