核心用法
Buildwright 是一个轻量级工程纪律层,专为AI辅助开发设计,提供五个核心命令:
- `/bw-work`:执行开发任务,遵循理解→研究→计划→红/绿/重构→文档→验证→安全审查→代码审查→提交的完整流程
- `/bw-plan`:纯研究模式,产出书面交付物而不修改代码
- `/bw-verify`:运行质量门禁(类型检查、Lint、测试、构建)
- `/bw-ship`:完整交付流程,包含验证、安全审查、Staff Engineer审查后提交PR
- `/bw-analyse`:分析存量代码库,生成技术栈文档与架构决策记录
框架采用双轨制配置:.buildwright/framework/ 为框架固定行为(自动更新),.buildwright/steering/ 为项目自定义(持久化)。内置TDD纪律、文档强制更新要求、以及基于提示词的Staff Engineer和安全工程师审查角色。
显著优点
1. 流程标准化:将Red-Green-Refactor TDD循环、安全审查、代码审查固化为可重复执行的命令
2. 文档即契约:强制要求每个面向用户的变更必须更新文档或说明原因,解决AI开发中的文档漂移问题
3. 安全内置:默认集成Semgrep、Gitleaks、TruffleHog扫描,/bw-ship前强制安全审查
4. 多IDE兼容:支持Claude Code、OpenCode、Cursor、Codex CLI,通过capability.md适配各平台原生功能
5. 存量友好:/bw-analyse可快速生成现有系统的ARCHITECTURE.md和CONVENTIONS.md
潜在缺点与局限性
1. Git依赖较重:要求git和gh CLI,对非Git工作流不友好
2. 安全工具可选:Semgrep等工具列为optional,实际安全覆盖取决于用户是否安装
3. Persona局限性:基于提示词的审查角色无法替代真实人类的专业判断,复杂安全场景仍需人工审计
4. 配置复杂度:递归读取所有.md文件的机制在大项目中可能引入意外配置覆盖
5. 版本较早期:v0.0.17表明API和框架行为可能仍有较大变动
适合人群
- 使用AI编码助手(Claude/Cursor等)的个人开发者,希望建立可重复的工程纪律
- 小型技术团队寻求轻量级代码审查替代方案
- 需要快速建立存量项目文档的维护团队
- 开源项目维护者希望标准化贡献者工作流
常规风险
| 风险类型 | 说明 | 缓解措施 |
|---------|------|---------|
| 过度自动化信任 | AI执行的"安全审查"可能被误认为充分 | 明确标注为辅助工具,关键变更仍需人工复核 |
| 配置漂移 | .buildwright/steering/的自定义配置可能与新版本框架冲突 | 建议版本锁定框架更新,变更前diff review |
| 文档形式主义 | "强制文档"可能导致低价值文档堆积 | philosophy.md中的YAGNI原则提供制衡 |
| 权限边界 | 虽声明不执行破坏性git操作,但 staged changes 仍可能包含敏感内容 | 配合git pre-commit hooks二次防护 |