1、介绍
Cobra 是一个 Go 语言开发的命令行(CLI)框架,它提供了简洁、灵活且强大的方式来创建命令行程序。
它包含一个用于创建命令行程序的库(Cobra 库),以及一个用于快速生成基于 Cobra 库的命令行程序工具(cobra-cli 命令)。
Cobra 是由 Go 团队成员 spf13 为 Hugo项目创建的,并已被许多流行的 Go 项目所采用,如 Kubernetes、Helm、Docker (distribution)、Etcd 等。
2、导入Cobra库
要使用 Cobra 创建命令行程序,需要先通过如下命令进行安装:
$ go get -u github.com/spf13/cobra/cobra
安装好后,就可以像其他 Go 语言库一样导入 Cobra 包并使用了。
import "github.com/spf13/cobra"
3、概念
Cobra 建立在命令、参数和标志这三个结构之上。要使用 Cobra 编写一个命令行程序,需要明确这三个概念。
- 命令(COMMAND):命令表示要执行的操作。
- 参数(ARG):是命令的参数,一般用来表示操作的对象。
- 标志(FLAG):是命令的修饰,可以调整操作的行为。
【命令(Command)】
命令是你想要执行的操作。在Cobra中,一个命令通常对应一个操作或一组操作。例如,在Git中,clone、commit、push 都是不同的命令,分别用于克隆仓库、提交更改和推送到远程仓库。
【参数(Argument)】
参数通常是命令操作的对象,它们直接影响命令的行为。参数一般不带有前缀。比如在命令 git clone https://github.com/user/repo.git 中,https://github.com/user/repo.git 是 clone 命令的参数,指定了要克隆的仓库地址。
【标志(Flag)】
标志是用来修改命令行为的选项。它们通常是可选的,并且前面带有 - 或 --。比如,在 docker run -d --name my_container my_image 中,-d 和 --name my_container 是 docker run 命令的标志。-d 表示后台运行容器,–name my_container 指定了容器的名称。
【示例】
// 在这个程序中:
app 是根命令。
dosomething 是一个子命令,用于处理文件。
[file] 是 dosomething 命令的参数,代表要处理的文件。
--verbose 或 -v 是一个标志,用于启用详细模式。
// 当你运行 app dosomething myfile.txt --verbose 时:
app dosomething 是命令部分。
myfile.txt 是参数,指定了 dosomething 要处理的文件。
--verbose 是标志,它修改了 dosomething 的行为,使其在处理文件时提供更详细的输出。
/////////////////////////////////////////////////////////////
var rootCmd = &cobra.Command{
Use: "app",
Short: "My application does wonderful things",
}
var cmdDoSomething = &cobra.Command{
Use: "dosomething [file]",
Short: "Do something with a file",
Args: cobra.MinimumNArgs(1),
Run: func(cmd *cobra.Command, args []string) {
fmt.Println("Doing something with", args[0])
},
}
func init() {
rootCmd.