导语:今天在mac环境中没法成功安装cobra,记录一下避免以后踩坑。
执行go get报错
更换安装方式 安装cobra-cli
go get -u github.com/spf13/cobra@latest
go install github.com/spf13/cobra-cli@latest
cp /Users/xujiamin/go/bin/cobra-cli /Users/xujiamin/go/bin/cobra
测试cobra的功能是否可用
cobra-cli init
go run main.go
添加子命令
cobra-cli add wget
cobra-cli add ping
在wget.go 中定义了一个wgetCmd结构体指针,可通过查看Command结构体原型添加或移除成员变量。这里我们添加了一个Example
用于指示示例,Short和Long为命令简介,Run为wget命令的真正实现。
我们知道在go中包的init()函数会在import时执行,通过AddCommand(wgetCmd)
将wegetCmd添加到结构体Command
成员变量commands中,包括后面我们编写的Flag也是如此。
接下来我们在结构体中添加Args用于验证(限制)参数数量,在init()函数中添加Flag -o
用于保存下载的文件地址,并通过MarkFlagRequired
约束flag的参数必须输入,最后在Run中调用Download即可。
# wget.go
package cmd
import (
"fmt"
"io"
"log"
"net/http"
"os"
"github.com/spf13/cobra"
)
var (
output string
)
// wgetCmd represents the wget command
var wgetCmd = &cobra.Command{
Use: "wget",
Example: "xpower wget iqsing.github.io/download.tar.gz -o /tmp/download.tar.gz",
Args: cobra.ExactArgs(1),
Short: "wget is a download cli.",
Long: `use wget to download everything you want from net.`,
Run: func(cmd *cobra.Command, args []string) {
fmt.Println("---wget running---")
Download(args[0], output)
},
}
func init() {
rootCmd.AddCommand(wgetCmd)
// Here you will define your flags and configuration settings.
wgetCmd.Flags().StringVarP(&output, "output", "o", "", "output file")
wgetCmd.MarkFlagRequired("output")
}
func Download(url string, path string) {
out, err := os.Create(path)
check(err)
defer out.Close()
res, err := http.Get(url)
check(err)
defer res.Body.Close()
_, err = io.Copy(out, res.Body)
check(err)
fmt.Println("save as" + path)
}
func check(err error) {
if err != nil {
log.Fatal(err)
}
}
args
Args: cobra.ExactArgs(1)
cobra内置的参数验证也是比较多,NoArgs、OnlyValidArgs、MinimumNArgs、MaximumNArgs等等可翻阅源码args.go,可以满足基本使用,如果有自己的特殊要求可以通过解析arg来实现。
flags
wgetCmd.Flags().StringVarP(&output, "output", "o", "", "output file(required)")
flag包含局部和全局两种,全局flag在父命令定义后子命令也会生效,而局部flag则在哪定义就在哪生效。
如上面的局部flag,我们在wgetCmd中定义的flag只有wget这个子命令能用。
全局flag
rootCmd.PersistentFlags().BoolVarP(&Verbose, "verbose", "v", false, "verbose output")
StringVarp
、BoolVarP
用于flag数据类型限制。
简单的应用从命令行直接写入参数是很常见的,但是如果比较复杂的命令行应用参数需要非常多,再这样操作不太合理,cobra作者还写了另一个在go中很流行的包viper用于解析配置文件,比如kubectl 的yml,以及各种json
前面也说过可以无缝衔接,只需Bind一下即可。
var author string
func init() {
rootCmd.PersistentFlags().StringVar(&author, "author", "YOUR NAME", "Author name for copyright attribution")
viper.BindPFlag("author", rootCmd.PersistentFlags().Lookup("author"))
}
flag还可以做依赖,比如下面username和password必须同时接收到参数。
rootCmd.Flags().StringVarP(&u, "username", "u", "", "Username (required if password is set)")
rootCmd.Flags().StringVarP(&pw, "password", "p", "", "Password (required if username is set)")
rootCmd.MarkFlagsRequiredTogether("username", "password")
https://zhuanlan.zhihu.com/p/501304994
https://pkg.go.dev/github.com/spf13/cobra?tab=versions