用途
report-bug 是 compound-engineering 插件提供的缺陷报告命令,用于在使用该插件时遇到问题后,向维护者提交结构化的 bug 报告。它负责收集信息、整理格式,并通过 GitHub CLI 创建 issue。
主要能力
该命令会引导用户依次提供以下信息:
- 问题类别:Agent 不工作、Command 不工作、Skill 不工作、MCP 服务器问题、安装问题、其他
- 受影响的具体组件:Agent、Command、Skill 或 MCP 服务器的名称
- 实际行为:使用该组件时发生了什么
- 预期行为:原本期望发生什么
- 复现步骤:出现 bug 前执行了哪些操作
- 错误信息:是否看到错误输出,如有则提供
同时自动采集环境信息:
- 插件版本:读取 ~/.claude/plugins/installed_plugins.json 中 compound-engineering 相关条目
- Claude Code 版本:执行 claude --version
- 操作系统信息:执行 uname -a
使用方式
命令会按以下流程执行:
- 通过 AskUserQuestion 工具收集上述 bug 信息。
- 自动采集插件版本、Claude Code 版本和操作系统信息。
- 将信息整理为结构化报告,包含 Bug Description、Environment、What Happened、Expected Behavior、Steps to Reproduce、Error Messages、Additional Context 等部分。
- 使用 GitHub CLI 创建 issue,命令形式为:
gh issue create \
--repo EveryInc/compound-engineering-plugin \
--title "[compound-engineering] Bug: [Brief description]" \
--body "[Formatted bug report from Step 3]" \
--label "bug,compound-engineering"
若标签不存在,则去掉 --label 参数重新创建。
- 创建成功后显示 issue URL,感谢用户报告,并说明维护者 Kieran Klaassen 会收到通知。
适用场景
适用于使用 compound-engineering 插件时遇到 Agent、Command、Skill、MCP 服务器或安装相关问题的用户,希望快速生成规范报告并提交到官方仓库。
限制与错误处理
- 若 gh CLI 未认证,会提示用户先运行 gh auth login。
- 若 issue 创建失败,会展示已格式化的报告,供用户手动创建 issue。
- 若缺少必填信息,会针对该字段重新询问。
隐私说明
该命令不会收集个人信息、API 密钥或凭据、项目私有代码,以及超出基本系统信息的文件路径;报告中仅包含与 bug 相关的技术信息。