GitHub.com/spf13/cobra 使用方法笔记

cobra 是一个强大的 Go 语言库，用于构建命令行工具。以下是它的主要使用方法和步骤：

1. 安装 cobra

使用 go get 下载库：

go get -u github.com/spf13/cobra

如需自动生成代码，还需要安装 cobra-cli：

go install github.com/spf13/cobra-cli@latest

2. 基本用法

2.1 创建命令行工具

示例代码：

package main

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

func main() {
    var rootCmd = &cobra.Command{
        Use:   "mycli",                // 命令的名字
        Short: "这是一个简单的命令行工具", // 简短描述
        Run: func(cmd *cobra.Command, args []string) {
            fmt.Println("欢迎使用这个工具！")
        },
    }

    rootCmd.Execute() // 运行命令
}

执行命令：

go run main.go

输出：

欢迎使用这个工具！

2.2 添加子命令

示例代码：

package main

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

func main() {
    var rootCmd = &cobra.Command{
        Use:   "mycli",
        Short: "这是一个简单的命令行工具",
    }

    var helloCmd = &cobra.Command{
        Use:   "hello",
        Short: "打印问候语",
        Run: func(cmd *cobra.Command, args []string) {
            fmt.Println("你好，世界！")
        },
    }

    rootCmd.AddCommand(helloCmd) // 添加子命令

    rootCmd.Execute() // 运行命令
}

执行命令：

go run main.go hello

输出：

你好，世界！

3. 组织代码

3.1 分包管理

将命令逻辑拆分到单独的文件或包中，便于维护。

目录结构：

project/
├── main.go
├── command/
│   ├── root.go
│   ├── hello.go

main.go：

package main

import "your_project/command"

func main() {
    command.Execute()
}

command/root.go：

package command

import "github.com/spf13/cobra"

var rootCmd = &cobra.Command{
    Use:   "app",
    Short: "Root command for the app",
}

func Execute() {
    rootCmd.Execute()
}

command/hello.go：

package command

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

func init() {
    var helloCmd = &cobra.Command{
        Use:   "hello",
        Short: "打印问候语",
        Run: func(cmd *cobra.Command, args []string) {
            fmt.Println("你好，世界！")
        },
    }

    rootCmd.AddCommand(helloCmd) // 注册子命令
}

3.2 执行流程

1. main.go 调用 command.Execute()。
2. command/root.go 定义 rootCmd 并执行 rootCmd.Execute()。
3. 在包加载时，hello.go 的 init() 函数注册子命令到 rootCmd。
4. cobra 根据用户输入解析命令并执行对应的 Run 函数。

4. 添加命令参数和标志

4.1 添加命令参数

示例代码：

var helloCmd = &cobra.Command{
    Use:   "hello [name]",
    Short: "打印问候语",
    Args:  cobra.MinimumNArgs(1), // 至少需要一个参数
    Run: func(cmd *cobra.Command, args []string) {
        fmt.Printf("你好，%s！\n", args[0])
    },
}

执行命令：

go run main.go hello 世界

输出：

你好，世界！

4.2 添加标志

示例代码：

var name string

var helloCmd = &cobra.Command{
    Use:   "hello",
    Short: "打印问候语",
    Run: func(cmd *cobra.Command, args []string) {
        fmt.Printf("你好，%s！\n", name)
    },
}

func init() {
    helloCmd.Flags().StringVarP(&name, "name", "n", "匿名", "指定名字")
    rootCmd.AddCommand(helloCmd)
}

执行命令：

go run main.go hello --name 世界

输出：

你好，世界！

5. 使用 cobra-cli 快速生成模板

5.1 初始化项目

cobra-cli init --pkg-name your_project

生成的目录结构：

.
├── cmd/
│   └── root.go
├── main.go

5.2 添加子命令

cobra-cli add hello

生成的文件：

cmd/
└── hello.go

在 cmd/hello.go 文件中实现子命令逻辑。

6. 总结

cobra 提供了灵活的框架来构建复杂的命令行工具，其核心包括：

1. rootCmd 和子命令的注册。
2. 参数解析与标志处理。
3. 代码的模块化组织。
4. cobra-cli 的辅助工具。

通过合理使用 cobra，可以轻松实现功能强大的 CLI 工具。