玩转Go命令行工具Cobra

Cobra是一个流行的Go命令行工具库，可以很方便地用于生成和管理CLI工具。本文介绍了如何在Go项目中使用Cobra来创建命令行工具，示例包括创建简单的CLI工具和一个带有子命令的CLI工具。

安装Cobra

要使用Cobra，需要先安装它，可以使用下面的命令进行安装：

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

创建CLI工具

创建一个简单的CLI工具

在使用Cobra之前，需要先创建一个基本的Go应用程序。下面是一个简单的示例程序：

package main

import (
    "fmt"
    "os"
)

func main() {
    if len(os.Args) < 2 {
        fmt.Println("usage: hello <name>")
        os.Exit(1)
    }
    name := os.Args[1]
    fmt.Printf("Hello, %s!\n", name)
}

这个程序打印出了带有参数的“Hello world”。

在使用Cobra之前，需要添加以下代码来生成CLI工具：

package main

import (
    "fmt"
    "os"

    "github.com/spf13/cobra"
)

func main() {
    var name string

    cmd := &cobra.Command{
        Use:   "hello",
        Short: "Prints hello world with a name",
        Run: func(cmd *cobra.Command, args []string) {
            fmt.Printf("Hello, %s!\n", name)
        },
    }

    cmd.Flags().StringVarP(&name, "name", "n", "world", "the name to greet")

    if err := cmd.Execute(); err != nil {
        fmt.Fprintln(os.Stderr, err)
        os.Exit(1)
    }
}

在这里，我们导入Cobra包，然后创建一个&cobra.Command，在这个命令中定义了名字、短描述和一个运行函数。

还可以使用cmd.Flags().StringVarP()方法来定义名字参数。这个方法的参数包括变量（在这里是name）、名称、缩写、默认值和描述。

创建带子命令的CLI工具

Cobra还可以用于创建具有子命令的CLI工具。下面是一个示例程序，它可以创建、列出和删除文件。

package main

import (
    "fmt"
    "os"

    "github.com/spf13/cobra"
)

func main() {
    var (
        filename string
        list     bool
        delete   bool
    )

    createCmd := &cobra.Command{
        Use:   "create [filename]",
        Short: "Creates a new file",
        Long:  "Creates a new file with the specified filename.",
        Args:  cobra.MaximumNArgs(1),
        Run: func(cmd *cobra.Command, args []string) {
            fmt.Printf("Creating file %s\n", filename)
        },
    }

    listCmd := &cobra.Command{
        Use:   "list",
        Short: "Lists all files",
        Long:  "Lists all files in the current directory.",
        Run: func(cmd *cobra.Command, args []string) {
            fmt.Println("Listing files...")
        },
    }

    deleteCmd := &cobra.Command{
        Use:   "delete [filename]",
        Short: "Deletes a file",
        Long:  "Deletes the specified file.",
        Args:  cobra.MaximumNArgs(1),
        Run: func(cmd *cobra.Command, args []string) {
            fmt.Printf("Deleting file %s\n", filename)
        },
    }

    rootCmd := &cobra.Command{
        Use: "filetool",
    }

    rootCmd.AddCommand(createCmd, listCmd, deleteCmd)

    createCmd.Flags().StringVarP(&filename, "filename", "f", "", "the name of the file to create")
    listCmd.Flags().BoolVarP(&list, "list", "l", false, "list all files")
    deleteCmd.Flags().BoolVarP(&delete, "delete", "d", false, "delete a file")

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

在这里，我们创建了一个根命令rootCmd以及三个子命令createCmd、listCmd和deleteCmd。每个子命令都有不同的用途，并且在Run方法中执行命令。

对于每个命令，我们还可以使用AddCommand()方法将子命令添加到根命令中。

我们还定义了每个命令的命令行标志，可以在运行命令时使用这些标志。

结论

使用Cobra可以很容易地创建和管理命令行应用程序和CLI工具。在本文中，我们介绍了如何使用Cobra来创建简单的CLI工具和带有子命令的CLI工具。还有许多其他功能可以在Cobra中使用，可以参考Cobra的文档和示例来了解更多信息。