SuperAPI AI 工具集

golang-spf13-cobra

编程与开发

查看项目

更新于 10-16 08:44

技能介绍

用途:在 Go 中用 spf13/cobra 构建命令行命令树,覆盖从零搭建、扩展子命令与标志、审查现有 CLI 三种模式。

主要能力:命令/子命令树(AddCommand、AddGroup)、标志解析(基于 pflag,区分 PersistentFlags 与 Flags)、位置参数校验(NoArgs、ExactArgs、MinimumNArgs、MaximumNArgs、RangeArgs、OnlyValidArgs、ExactValidArgs,可用 MatchAll 组合或自定义校验函数)、Shell 补全生成(ValidArgs、ValidArgsFunction、RegisterFlagCompletionFunc)以及文档生成。运行钩子按 PersistentPreRunE → PreRunE → RunE → PostRunE → PersistentPostRunE 顺序执行。

使用方式:安装命令为 go get github.com/spf13/cobra@latest。建议始终使用 RunE 而非 Run;配置初始化放在 PersistentPreRunE;参数校验用 Args 而非在 RunE 内写 len(args);输出统一用 cmd.OutOrStdout()/cmd.ErrOrStderr();测试时用 SetOut/SetArgs 并以 rootCmd.Execute() 驱动,且每个测试重建命令树,因为 cobra 会在多次 Execute 间累积标志状态。

与 viper 的关系:cobra 负责命令树、标志、参数校验与补全,viper 负责配置值解析;仅需标志时只用 cobra,仅需 YAML/环境变量配置的常驻服务只用 viper,两者结合时通过 BindPFlag 在根命令的 PersistentPreRunE 绑定。

限制:该技能并非穷尽,需参考库文档与示例;子命令的 PersistentPreRunE 会完全替换父命令的钩子,需显式调用父钩子;PostRunE 仅在 RunE 成功时执行。具体版本、平台与收费信息暂未提供。