用途:pr-desc 用于自动撰写 Pull Request 描述,读取当前分支的代码变更并生成结构化文本,减少手工编写 PR 说明的工作量。
主要能力:分析分支变更;生成结构化 PR 描述;列出改了什么以及为什么改;识别破坏性变更;补充测试说明;支持指定 base 与 head 分支进行比较;支持生成截图占位符;输出可复制到剪贴板。
使用方式:在 git 仓库中运行 npx ai-pr-desc 生成当前分支的描述;用 npx ai-pr-desc --base main --head feature/auth 比较指定分支;用 npx ai-pr-desc | pbcopy 复制到剪贴板;用 npx ai-pr-desc --screenshots 加入截图占位符。输出格式包含 What、Why、Changes、Testing、Breaking Changes 等小节。
适用场景:需要快速为功能分支、修复分支生成 PR 说明的开发者,尤其适合希望统一 PR 描述结构的团队。
限制与要求:需要 Node.js 18+;需要设置 OPENAI_API_KEY;必须在 git 仓库内运行。许可证为 MIT,资料称可永久免费使用。其他平台支持、价格变动或效果细节暂未提供。