cobra的使用

Cobra：Go语言命令行工具

引言

在Linux/Unix世界中，ls、git、kubectl等命令行工具以其强大的功能和一致的交互体验成为开发者日常工作的基石。
在Go语言生态中，Cobra是构建命令行工具的一把好手, 我通过他来构建了工作中常用的一些命令工具,如域名数据分析, Cname分析等。

---

快速搭建命令行骨架

1. 基础用法

Cobra通过树状结构管理命令层级，每个节点都是一个独立命令：

go get -u github.com/spf13/cobra@latest

package main

import (
	"fmt"
	"github.com/spf13/cobra"
)

func main() {
	var cmdRoot = &cobra.Command{
		Use:   "app",
		Short: "示例CLI工具",
		Run: func(cmd *cobra.Command, args []string) {
			fmt.Println("Welcome to Cobra!")
		},
	}

	if err := cmdRoot.Execute(); err != nil {
		panic(err)
	}
}

2. 核心概念

• Command：代表一个可执行命令（如git commit）
• Flag：命令行参数（短格式-f/长格式--file）
• Subcommand：子命令（如kubectl get pods中的get）

---

详细使用细节

1. 子命令系统

通过AddCommand()构建命令树：

var cmdUser = &cobra.Command{
	Use:   "user",
	Short: "用户管理",
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println("user called")
	},
}

var cmdCreateUser = &cobra.Command{
	Use:   "create",
	Short: "创建用户",
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println("Creating user...")
	},
}

func main() {
	cmdRoot.AddCommand(cmdUser)
	cmdUser.AddCommand(cmdCreateUser)
	cmdRoot.Execute()
}

2. 参数处理系统

• Positional Arguments：位置参数
• Persistent Flags：跨子命令共享的标志
• Local Flags：仅限当前命令的标志

cmdCreateUser.Flags().StringP("name", "n", "default", "用户名")
cmdCreateUser.PersistentFlags().Bool("verbose", false, "启用详细日志")

// 访问参数
name, _ := cmdCreateUser.Flags().GetString("name")
verbose, _ := cmdCreateUser.PersistentFlags().GetBool("verbose")

3. 插件系统

通过cobra.Command.Use实现动态插件加载：

// plugins/hello.go
package plugins

import (
	"github.com/spf13/cobra"
)

func init() {
	rootCmd.AddCommand(&cobra.Command{
		Use:   "hello",
		Short: "打招呼",
		Run: func(cmd *cobra.Command, args []string) {
			println("Hello from plugin!")
		},
	})
}

---

构建Git-like CLI工具

1. 项目结构

mycli/
├── cmd/
│   ├── root.go
│   ├── version.go
│   └── git/
│       ├── commit.go
│       └── branch.go
└── main.go

2. 核心代码

// cmd/root.go
var rootCmd = &cobra.Command{
	Use:   "mycli",
	Short: "现代CLI工具框架",
}

func Execute() {
	if err := rootCmd.Execute(); err != nil {
		fmt.Println(err)
		os.Exit(1)
	}
}

// cmd/version.go
var versionCmd = &cobra.Command{
	Use:   "version",
	Short: "显示版本信息",
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println("mycli v1.0.0")
	},
}

// cmd/git/commit.go
var commitCmd = &cobra.Command{
	Use:   "commit",
	Short: "提交代码",
	Run: func(cmd *cobra.Command, args []string) {
		message, _ := cmd.Flags().GetString("message")
		fmt.Printf("Committing with message: %s\n", message)
	},
}

func init() {
	commitCmd.Flags().StringP("message", "m", "", "提交信息")
	rootCmd.AddCommand(versionCmd)
	gitCmd.AddCommand(commitCmd)
}

---

最佳实践

1. 自动生成文档

cobra add serve --help

2. 自定义帮助模板

rootCmd.SetHelpTemplate(`{{.UsageString}}

可用命令:
{{range .Commands}}{{.Name | printf "  %-10s" }} {{.Short}}
{{end}}`)

---

总结

Cobra通过约定优于配置的理念，将复杂的命令行解析标准化。无论是简单脚本还是企业级CLI工具，Cobra都能提供：

• 清晰的命令层次结构
• 强大的参数验证系统
• 丰富的扩展机制
• 完善的帮助文档生成

建议结合Cobra官方文档深入学习，构建属于你的命令行工具！
```