命令行工具开发 cobra 示例

Cobra 的主要组件
应用场景
示例

Cobra 是 Go 语言中一个流行的库，用于创建命令行应用程序。它提供了一个易于使用的框架，帮助开发者快速构建强大且灵活的 CLI（Command-Line Interface）工具。Cobra 的主要特点包括命令层次结构、命令行标志（flags）和参数处理、自动生成帮助文档等。

Cobra 的主要组件

命令（Command）：
- Cobra 的核心是 Command 结构体，每个命令都被表示为一个 Command 实例。命令可以有子命令，从而形成一个层次结构。例如，一个 Git 工具的 git commit 和 git push 可以被实现为 commit 和 push 子命令。
- 每个命令都有一个名字、简短描述、长描述、以及一个执行函数。
标志（Flags）：
- Cobra 与 pflag（Go 标准库 flag 包的增强版）集成，用于处理命令行标志。每个命令可以定义自己的标志，用户可以在命令行中使用这些标志来修改命令的行为。
自动生成帮助和手册：
- Cobra 自动生成命令的帮助信息，帮助用户了解命令及其使用方法。只需简单配置，Cobra 还可以生成 shell 的自动补全脚本。
命令的层次结构：
- Cobra 支持创建复杂的命令结构，允许命令具有子命令，并且子命令也可以进一步有自己的子命令。这使得开发者能够构建功能丰富的 CLI 工具。

应用场景

Cobra 被广泛用于构建 Go 语言的 CLI 应用程序，许多著名的 Go 项目都采用了 Cobra，例如 Kubernetes 的 kubectl 工具、Docker 的 docker 命令行工具等。

示例

接下来，将通过一个具体的示例来详细介绍如何使用 Cobra 开发一个命令行工具。我们将开发一个简单的命令行工具 task，用于管理待办事项（To-Do List）。这个工具将支持以下功能：

添加任务
列出任务
标记任务为完成

第一步：创建 Go 项目并安装 Cobra

首先，创建一个新的 Go 项目：

mkdir task-cli
cd task-cli
go mod init task-cli

接着，安装 Cobra 库：

go get -u github.com/spf13/cobra

第二步：初始化 Cobra 命令

在项目根目录下创建 main.go 文件并添加以下代码：

package main

import (
    "fmt"
    "os"

    "github.com/spf13/cobra"
)

var rootCmd = &cobra.Command{
    Use:   "task",
    Short: "Task is a CLI tool for managing your tasks",
    Long:  `A simple command-line application to manage tasks.`,
}

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

第三步：实现添加任务的命令

首先，我们需要一个简单的结构体来表示任务，并且在内存中存储任务列表。然后，创建一个 add 命令用于添加任务。

创建一个 task.go 文件用于定义任务结构体：

package main

var tasks = []Task{}

type Task struct {
    Name   string
    Done   bool
}

然后在 main.go 中添加 addCmd 命令：

var addCmd = &cobra.Command{
    Use:   "add [task name]",
    Short: "Add a new task",
    Long:  "Add a new task to your task list.",
    Args:  cobra.MinimumNArgs(1),
    Run: func(cmd *cobra.Command, args []string) {
        taskName := args[0]
        tasks = append(tasks, Task{Name: taskName})
        fmt.Printf("Added task: %s\n", taskName)
    },
}

func init() {
    rootCmd.AddCommand(addCmd)
}

第四步：实现列出任务的命令

接下来，添加一个 list 命令，用于显示所有任务。

在 main.go 中添加 listCmd 命令：

var listCmd = &cobra.Command{
    Use:   "list",
    Short: "List all tasks",
    Long:  "List all tasks in your task list.",
    Run: func(cmd *cobra.Command, args []string) {
        fmt.Println("Tasks:")
        for i, task := range tasks {
            status := "Pending"
            if task.Done {
                status = "Done"
            }
            fmt.Printf("%d. %s [%s]\n", i+1, task.Name, status)
        }
    },
}

func init() {
    rootCmd.AddCommand(listCmd)
}

第五步：实现标记任务为完成的命令

再添加一个 done 命令，用于标记某个任务为完成。

在 main.go 中添加 doneCmd 命令：

var doneCmd = &cobra.Command{
    Use:   "done [task number]",
    Short: "Mark a task as done",
    Long:  "Mark a task as completed by its number in the list.",
    Args:  cobra.MinimumNArgs(1),
    Run: func(cmd *cobra.Command, args []string) {
        taskNumber, err := strconv.Atoi(args[0])
        if err != nil || taskNumber < 1 || taskNumber > len(tasks) {
            fmt.Println("Invalid task number")
            return
        }

        tasks[taskNumber-1].Done = true
        fmt.Printf("Marked task %d as done\n", taskNumber)
    },
}

func init() {
    rootCmd.AddCommand(doneCmd)
}

第六步：运行和测试

现在可以运行并测试这个命令行工具了。

添加任务：

 go run main.go add "Learn Cobra"
 go run main.go add "Build a CLI tool"

列出任务：
```
 go run main.go list
```
标记任务为完成：
```
 go run main.go done 1
```
再次列出任务：
```
 go run main.go list
```

完整代码

main.go 的完整代码如下：

package main

import (
    "fmt"
    "os"
    "strconv"

    "github.com/spf13/cobra"
)

type Task struct {
    Name string
    Done bool
}

var tasks = []Task{}

var rootCmd = &cobra.Command{
    Use:   "task",
    Short: "Task is a CLI tool for managing your tasks",
    Long:  `A simple command-line application to manage tasks.`,
}

var addCmd = &cobra.Command{
    Use:   "add [task name]",
    Short: "Add a new task",
    Long:  "Add a new task to your task list.",
    Args:  cobra.MinimumNArgs(1),
    Run: func(cmd *cobra.Command, args []string) {
        taskName := args[0]
        tasks = append(tasks, Task{Name: taskName})
        fmt.Printf("Added task: %s\n", taskName)
    },
}

var listCmd = &cobra.Command{
    Use:   "list",
    Short: "List all tasks",
    Long:  "List all tasks in your task list.",
    Run: func(cmd *cobra.Command, args []string) {
        fmt.Println("Tasks:")
        for i, task := range tasks {
            status := "Pending"
            if task.Done {
                status = "Done"
            }
            fmt.Printf("%d. %s [%s]\n", i+1, task.Name, status)
        }
    },
}

var doneCmd = &cobra.Command{
    Use:   "done [task number]",
    Short: "Mark a task as done",
    Long:  "Mark a task as completed by its number in the list.",
    Args:  cobra.MinimumNArgs(1),
    Run: func(cmd *cobra.Command, args []string) {
        taskNumber, err := strconv.Atoi(args[0])
        if err != nil || taskNumber < 1 || taskNumber > len(tasks) {
            fmt.Println("Invalid task number")
            return
        }

        tasks[taskNumber-1].Done = true
        fmt.Printf("Marked task %d as done\n", taskNumber)
    },
}

func main() {
    rootCmd.AddCommand(addCmd)
    rootCmd.AddCommand(listCmd)
    rootCmd.AddCommand(doneCmd)

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

声明：本作品采用署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0)进行许可，使用时请注明出处。

Author: mengbin

blog: mengbin

Github: mengbin92

cnblogs: 恋水无意

腾讯云开发者社区：孟斯特