go cobra一个简单好用的命令行工具

简介

Cobra是一个用Go语言实现的命令行工具。并且现在正在被很多项目使用，例如：Kubernetes,、Hugo和Github CLI等。通过使用Cobra，不仅可以快速的创建命令行界面，也可以快速开发基于Cobra的应用程序。

在cobra的git地址上有详细的使用教程，本篇文章是学习总结。cobra的git地址为：github.com/spf13/cobra

项目创建

cobra init --pkg-name=appName
示例：
mkdir newApp && cd newAPP
go mod init newAPp
cobra init --pkg-name=newApp

初始文件分析

mian.go

package main

import "newApp/cmd"

func main() {
	cmd.Execute()
}

cmd/root.go

package cmd
var cfgFile string

// rootCmd表示在没有任何子命令的情况下调用的基本命令
var rootCmd = &cobra.Command{
	Use:   "newApp",
	Short: "命令的简单描述, 当不指定这个命令时，显示这个描述。",
	Long: `命令的详细描述， 当指定这个命令时，显示这个描述.
				例如：newName -h`,
		
	// 当调用就这个命令时，就会执行到这里。			
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println("newapp is called")
	},
}

// 这个函数由main()调用。只需要在根cmd上发生一次。
// Execute() 也将所有子命令添加到根命令并适当的设置标志。
func Execute() {
	cobra.CheckErr(rootCmd.Execute())
}

// init 函数，主要设置一些配置
func init() {

	cobra.OnInitialize(initConfig)

	// cobra支持全局的标志，在这里定义的标志全局可用。
	// 这个标志下面会介绍到
	//rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.new.yaml)")

	
	// cobra也支持局部标志，在这里定义的只会在命令发送时调用。
	// 下面也会介绍到
	//rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")

}

// 配置文件
func initConfig() {
	...
	...
}