用Golang开发首个CLI工具，cobra库入门教程

本篇文章向大家介绍《用Golang写第一个CLI工具，cobra库入门详解》，主要包括，具有一定的参考价值，需要的朋友可以参考一下。

使用Golang和cobra库可以快速构建结构清晰的CLI工具。首先安装cobra库，运行go get -u github.com/spf13/cobra/cobra；其次创建项目目录并初始化，用cobra init生成基础结构；接着通过cobra add sayhello添加子命令，并在Run函数中实现功能逻辑；随后可在init()中定义flag以支持参数传递；最后运行go build将程序编译为可执行文件并部署到系统路径。以上步骤即可完成一个具备基本功能的CLI工具开发。

用 Golang 编写 CLI 工具其实挺常见的，尤其是当你想做一些自动化脚本或者小型命令行应用的时候。而 cobra 库就是 Go 语言中最流行的一个 CLI 框架，它能帮你快速构建出结构清晰、支持子命令的命令行程序。

下面我们就一步步来实践一下，怎么用 cobra 写一个简单的 CLI 工具。

安装 Cobra

首先，你需要安装 cobra 这个库。打开终端，运行：

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

这个命令会把 cobra 的命令行工具也装好，之后你就可以用 cobra 命令来生成项目骨架了。

安装完成后，你可以输入 cobra --help 看看有没有输出帮助信息，确认是否安装成功。

初始化你的 CLI 项目

接下来我们创建一个目录，比如叫 mycli，然后进去初始化一个 Cobra 项目：

mkdir mycli && cd mycli
cobra init

执行完后，你会看到项目里多了几个文件和目录，比如 main.go 和 cmd/root.go。这些是 cobra 自动生成的基础结构。

你可以先运行一下看看效果：

go run main.go

默认情况下会输出 root 命令的帮助信息，类似这样：

A longer description that spans multiple lines and likely contains
examples and usage of using your application.

别担心，这只是个模板，后面我们会改掉它。

添加一个子命令：sayhello

现在我们来加一个自己的命令，比如 sayhello，运行它时打印一句“Hello from CLI!”。

用下面这行命令生成一个新命令：

cobra add sayhello

这时候会在 cmd/ 目录下多一个 sayhello.go 文件。打开它，找到 Run 函数，在里面加上我们要输出的内容：

func runSayhello(cmd *cobra.Command, args []string) {
    fmt.Println("Hello from CLI!")
}

保存后运行：

go run main.go sayhello

你应该就能看到输出了：

Hello from CLI!

给命令添加参数和 Flag

CLI 工具光有命令还不够，通常还需要传参。我们继续在 sayhello 上扩展，让它支持一个名字参数，比如：

mycli sayhello --name Alice

输出：

Hello, Alice!

要实现这个功能，先在 init() 函数里定义 flag：

var name string

func init() {
    cmd := sayhelloCmd
    cmd.Flags().StringVarP(&name, "name", "n", "World", "Name to greet")
}

然后修改 runSayhello 函数：

func runSayhello(cmd *cobra.Command, args []string) {
    fmt.Printf("Hello, %s!\n", name)
}

现在再运行：

go run main.go sayhello --name Bob

就会输出：

Hello, Bob!

如果你不带参数，默认是 World。

构建可执行文件

写好了命令，下一步就是把它打包成一个真正的命令行程序。很简单，只需要运行：

go build -o mycli

之后你就能直接运行：

./mycli sayhello --name Tom

也可以把这个二进制文件放到系统路径里，比如 /usr/local/bin/，以后就不用带 ./ 了。

基本上就这些。cobra 的功能还有很多，比如自动补全、配置管理、嵌套命令等，但上面这几步已经足够让你写出一个像样的 CLI 工具了。用起来不复杂，但确实很实用。

今天关于《用Golang开发首个CLI工具，cobra库入门教程》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！