用 Cobra 构建 Go 命令行工具指南
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @kunlungrowth/kunlun-go-cobra-cli-guide。
技能介绍
要解决什么问题
用 Cobra 搭 Go 命令行工具时,常见问题不在「会不会 import 包」,而在子命令树怎么拆、flags 与配置怎么分层、错误码与退出语义是否一致,以及 PR 里没人按同一套标准看并发与边界。SKILL.md 把通用工程能力落到 Cobra CLI 场景:你给出 diff、报错栈、需求约束或选型对比,助手按固定工作流产出检查清单、方案骨架或定位步骤,而不是泛泛讲官方文档。
技能如何工作
技能通过触发词路由到六类能力:
- 代码评审:读 PR/diff,按正确性→安全→可维护性给出阻断/建议/可选分级意见
- 技术方案设计:在需求与约束下填充背景、目标、选型与风险模板
- 调试排错:从报错与上下文建复现路径,强调先证据后改代码
- 架构权衡:按场景与规模做候选对比表(利弊、成本、适用边界)
- API / 契约设计:围绕资源与操作整理 REST 风格字段、错误码约定
- 工程规范:针对 Go + Cobra 常见模式给清单与反模式
此外还有两套显式工作流:代码评审(先意图再正确性)与线上排错(复现→隔离→证据→验证)。输出物以模板为主,例如技术方案章节、评审检查清单、五维质量量表,可直接粘贴进设计 doc 或 CR 评论。
边界与注意点
技能提供方法论与模板,不代替合并决策,也不处理真实密钥或凭证(仅脱敏示例)。它不会替你写完整可运行项目,而是在你已有代码或问题时结构化思考;若场景偏离 CLI(例如纯 gRPC 服务无边 Cobra),需在输入里写清约束,否则通用模板权重会偏高。
使用场景
- 新加的 Cobra 子命令 PR 需要按同一清单查边界、并发与 flags 默认值
- 线上 CLI panic 只有片段日志,需要最小复现步骤和二分排查假设
- 团队在 `rootCmd` 与 viper 集成方式上争执,需要利弊与规模适用性的对比表
- 对外暴露的子命令要定错误码与 `--help` 契约,需要 REST 风格字段与错误语义草案
适合人员
- 维护内部运维 CLI、每周要合入多条 Cobra 相关 PR 的后端工程师
- 负责新项目 `main.go` 与子命令拆分方案、要写评审可读设计 doc 的技术负责人
- 独立开发者用 Cobra 发 OSS 工具,希望 CR 评论带分级理由而非口水战
- DevOps 值班遇到脚本化工具异常退出,要按证据链写复盘而非直接改代码