一、介绍
cobra是一个命令行程序库，其提供简单的接口来创建强大现代的CLI接口，可以用来编写命令行程序。同时，它也提供了一个脚手架， 用于生成基于 cobra 的应用程序框架。
二、概念
Cobra基于三个基本概念commands,arguments和flags。其中commands代表行为，arguments代表数值，flags代表对行为的改变。
基本模型如下：
APPNAME VERB NOUN --ADJECTIVE或者APPNAME COMMAND ARG --FLAG
例如：
# server是commands，port是flag
hugo server --port=1313
# clone是commands，URL是arguments，brae是flags
git clone URL --bare
Commands
Commands是应用的中心点，同样commands可以有子命令(children commands)，其分别包含不同的行为。
Commands的结构体如下：
type Command struct {
Use string // The one-line usage message.
Short string // The short description shown in the 'help' output.
Long string // The long message shown in the 'help <this-command>' output.
Run func(cmd *Command, args []string) // Run runs the command.
}
Flags
Flags用来改变commands的行为。其完全支持POSIX命令行模式和Go的flag包。这里的flag使用的是spf13/pflag包，具体可以参考Golang之使用Flag和Pflag.
cobra 中选项分为Flags，一种是永久选项，定义它的命令和其子命令都可以使用。通过给根命令添加一个选项定义全局选项。 另一种是本地选项，只能在定义它的命令中使用。
与flag一样，存储选项的变量也需要提前定义好：
var Verbose bool
var Source string
设置永久Flags：
rootCmd.PersistentFlags().BoolVarP(&Verbose, "verbose", "v", false, "verbose output")
设置本地Flags：
localCmd.Flags().StringVarP(&Source, "source", "s", "", "Source directory to read from")
Arguments
Leagacy arg validation有以下几类：
- NoArgs: 如果包含任何位置参数，命令报错
- ArbitraryArgs: 命令接受任何参数
- OnlyValidArgs: 如果有位置参数不在ValidArgs中，命令报错
- MinimumArgs(init): 如果参数数目少于N个后，命令行报错
- MaximumArgs(init): 如果参数数目多余N个后，命令行报错
- ExactArgs(init): 如果参数数目不是N个话，命令行报错
- RangeArgs(min, max): 如果参数数目不在范围(min, max)中，命令行报错
如: 命令行参数不少于1个
var helloCmd = &cobra.Command {
Use: "hello",
Short: "hello 子命令.",
Long: "这是一个Hello 子命令",
Args: cobra.MinimumNArgs(1),
Run: runHello,
}
自字义Arguments判断
var cmd = &cobra.Command{
Use: "hello",
Short: "hello",
Args: func(cmd *cobra.Command, args []string) error {
if len(args) < 1 {
return errors.New("requires at least one arg")
}
if myapp.IsValidColor(args[0]) {
return nil
}
return fmt.Errorf("invalid color specified: %s", args[0])
},
Run: func(cmd *cobra.Command, args []string) {
fmt.Println("Hello, World!")
},
}
三、快速使用
安装
go get github.com/spf13/cobra/cobra
导入
import "github.com/spf13/cobra"
文件结构
▾ cjapp/
▾ cmd/
hello.go
root.go
version.go
go.mod
main.go
go.mod
module zngw
go 1.14
require github.com/spf13/cobra v1.2.1
root.go
package cmd
import (
"fmt"
"github.com/spf13/cobra"
)
var rootCmd = &cobra.Command {
Use: "zngw",
Short: "这是 cobra 测试程序主入口",
Long: `这是 cobra 测试程序主入口， 无参数启动时进入`,
Run: runRoot,
}
func Execute() {
if err := rootCmd.Execute(); err != nil {
panic(err)
}
}
func runRoot(cmd *cobra.Command, args []string) {
fmt.Printf("execute %s args:%v \n", cmd.Name(), args)
// TODO 这里处理无参数启动时程序处理
}
hello.go
package cmd
import (
"fmt"
"github.com/spf13/cobra"
)
var helloCmd = &cobra.Command {
Use: "hello",
Short: "hello 子命令.",
Long: "这是一个Hello 子命令",
Args: cobra.MinimumNArgs(1),
Run: runHello,
}
func init() {
rootCmd.AddCommand(helloCmd)
}
func runHello(cmd *cobra.Command, args []string) {
// TODO 这里处理hello子命令
fmt.Println("Hello ", args[0])
}
version.go
package cmd
import (
"fmt"
"github.com/spf13/cobra"
)
var versionCmd = &cobra.Command {
Use: "version",
Short: "version 子命令.",
Long: "这是一个version 子命令",
Run: runVersion,
}
func init() {
rootCmd.AddCommand(versionCmd)
}
func runVersion(cmd *cobra.Command, args []string) {
// TODO 这里处理version子命令
fmt.Println("version is 1.0.0")
}
main.go
package main
import (
"zngw/cmd"
)
func main() {
cmd.Execute()
}
测试
进入工程目录，直接使用go build编译,编译后的可执行程序为zngw.exe
- 自带
-h参数,生成帮助信息
E:\55\cobra>zngw -h
这是 cobra 测试程序主入口， 无参数启动时进入
Usage:
zngw [flags]
zngw [command]
Available Commands:
completion generate the autocompletion script for the specified shell
hello hello 子命令.
help Help about any command
version version 子命令.
Flags:
-h, --help help for zngw
Use "zngw [command] --help" for more information about a command.
- 测试子命令
E:\55\zngw>zngw
execute zngw args:[]
E:\55\zngw>zngw hello guoke
Hello guoke
E:\55\zngw>zngw version
version is 1.0.0
