酷玩Go命令行工具—Cobra

简介: 酷玩Go命令行工具—Cobra

不知大家有没有在使用Git命令、Linux的yum命令、Go命令、Maven命令的时候感觉到非常的酷,比如你刚刚拿到一个Go的开源项目,初始化时只需要输入go mod tidy进行对依赖的下载,或者是git clone xxx之后拉下来一个GitHub上的项目,mvn package或者go build就可以将整合项目打包成一个可执行的文件,当然这些操作现在大多数都能通过可视化的UI界面进行,但是就少了一些韵味,还是使用原生的CLI工具最能体现程序执行的过程,并且真是的生产环境中大多数也只能通过这种命令的方式来进行,因此我们就有必要搞一下这个大蟒蛇工具——Cobra。

1 简介

网络异常,图片无法展示
|


GitHub:github.com/spf13/cobra

Cobra是一个用于创建强大的现代CLI应用程序的库。在很多围棋项目中使用,比如Kubernetes, Hugo和GitHub CLI等等。

那么什么是CLI呢,简单来讲就是命令行工具界面,Command Line Interface for batch scripting的简称,在我们开发中广泛的使用,比如你打开Git Bash,输入git clone XXX,这个就是操作Git的命令行工具界面。

除此之外,Cobra还提供:

  • 简单的基于子命令的cli:应用服务器,应用获取,等等。
  • 完全兼容posix的标志(包括短版本和长版本)
  • 嵌套的子命令
  • 全局、本地和级联标志
  • 命令和标志的自动帮助生成
  • 自动识别-h、——help等帮助标志。
  • 为您的应用程序自动生成shell自动完成(bash, zsh, fish, powershell)
  • 为您的应用程序自动生成的手册页
  • 命令别名,以便您可以更改而不破坏它们
  • 定义自己的帮助、用法等的灵活性。

什么是命令&参数&标识符?

Cobra 是构建在命令、参数和标识符之上的:

  • Commands 表示执行动作
  • Args 就是执行参数
  • Flags 是这些动作的标识符

基本的执行命令如下所示:

$ APPNAME Command Args --Flags 
# 或者
$ APPNAME Command --Flags Args
复制代码

2 安装

2.1 安装Cobra-cli脚手架工具

go install github.com/spf13/cobra-cli@latest
复制代码

下载完成之后会在我们的$GOPATH目录的bin目录下生成一个二进制的文件cobra-cli.exe(Windows下)或cobra-cli(LInux下),如果出现问题,如:

网络异常,图片无法展示
|


我们可以直接找到$GO_PATH\pkg\mod\github.com\spf13\cobra-cli@v1.3.0目录,直接go build自己编译一个二进制文件。

之后一步,为了方便使用我们可以将生成的二进制文件放在环境变量里,让他在任何地方都能使用,步骤过于简单就忽略了哈。

2.2 在项目中下载Cobra依赖

go get -u github.com/spf13/cobra@latest
复制代码

3 使用方式

其实在使用方式这一块有两种方法,一种是自己直接写代码,另一种就是使用刚刚我们安装的cobra-cli来生成脚手架代码,我们就在Hello World里面将cobra-cli生成代码试一遍。

3.1 Hello World

首先在项目根目录下打开终端(必须是Go Module项目),然后输入命令cobra-cli init就会在项目中生成如下代码:


网络异常,图片无法展示
|


我们看下具体的代码:

main.go

package main
import "go-cobra/cmd"
func main() {
   cmd.Execute()
}
复制代码

root.go

package cmd
import (
   "os"
   "github.com/spf13/cobra"
)
// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
   Use:   "go-cobra",
   Short: "A brief description of your application",
   Long: `A longer description that spans multiple lines and likely contains
examples and usage of using your application. For example:
Cobra is a CLI library for Go that empowers applications.
This application is a tool to generate the needed files
to quickly create a Cobra application.`,
   // Uncomment the following line if your bare application
   // has an action associated with it:
   // Run: func(cmd *cobra.Command, args []string) { },
}
// Execute adds all child commands to the root command and sets flags appropriately.
// This is called by main.main(). It only needs to happen once to the rootCmd.
func Execute() {
   err := rootCmd.Execute()
   if err != nil {
      os.Exit(1)
   }
}
func init() {
   // Here you will define your flags and configuration settings.
   // Cobra supports persistent flags, which, if defined here,
   // will be global for your application.
   // rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.go-cobra.yaml)")
   // Cobra also supports local flags, which will only run
   // when this action is called directly.
   rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
}
复制代码

我们将root.go里面的代码进行部分修改:

package cmd
import (
   "fmt"
   "github.com/spf13/cobra"
   "os"
)
var name string
var rootCmd = &cobra.Command{
   Use: "hello",
   Run: func(cmd *cobra.Command, args []string) {
      fmt.Println("hello ", name)
   },
}
func Execute() {
   err := rootCmd.Execute()
   if err != nil {
      os.Exit(1)
   }
}
func init() {
   rootCmd.Flags().StringVarP(&name, "name", "", "world", "")
}
复制代码

测试:

$ go build
$ .\go-cobra.exe --name zs
hello  zs
$ .\go-cobra.exe
hello  world
复制代码

3.2 开发自己的Cli命令

使用cobra-cli脚手架,或者也可以自己手写如下代码

cobra-cli add hi
复制代码

这个时候我们就会发现多了一个文件,当然也可以自己手写代码:


网络异常,图片无法展示
|


在hi.go文件中代码:

package cmd
import (
   "fmt"
   "github.com/spf13/cobra"
)
var (
   age     int
   like    []string
   address string
)
var hiCmd = &cobra.Command{
   Use:   "hi",
   Short: "",
   Long:  "",
   Run: func(cmd *cobra.Command, args []string) {
      Print()
   },
}
func init() {
   rootCmd.AddCommand(hiCmd)
   hiCmd.Flags().StringVarP(&name, "name", "", "world", "")
   hiCmd.Flags().IntVarP(&age, "age", "", 1, "")
   hiCmd.Flags().StringSliceVarP(&like, "like", "", []string{}, "")
   hiCmd.Flags().StringVarP(&address, "address", "", "Beijing", "")
}
func Print() {
   fmt.Println("name:", name)
   fmt.Println("age:", age)
   fmt.Println("like:", like)
   fmt.Println("address:", address)
}
复制代码

测试:

.\go-cobra.exe hi --name zs --age 100 --like Coding,Running --address ShangHai
name: zs
age: 100
like: [Coding Running]
address: ShangHai
复制代码

3.3 规则和扩展使用

3.3.1 我们不难看出规则
  • 新增命令就是自定义&cobra.Command
  • 新增标识符就是命令.Flags().xxx
  • 新增的命令都需要在rootCmd中添加,新增的标识符都要在init中添加
3.3.2 小扩展

一些常用到的方法:

  • NoArgs:如果有任何参数,命令行将会报错
  • ArbitraryArgs: 命令行将会接收任何参数
  • OnlyValidArgs: 如果有如何参数不属于 Command 的 ValidArgs 字段,命令行将会报错
  • MinimumNArgs(int): 如果参数个数少于 N 个,命令行将会报错
  • MaximumNArgs(int): 如果参数个数多于 N 个,命令行将会报错
  • ExactArgs(int): 如果参数个数不等于 N 个,命令行将会报错
  • RangeArgs(min, max): 如果参数个数不在 min 和 max 之间, 命令行将会报错
3.3.3 自定义帮助命令
...
var hiCmd = &cobra.Command{
   Use:   "hi",
   Short: "sss",
   Long:  "lll",
   Run: func(cmd *cobra.Command, args []string) {
      if len(args) == 0 {
         cmd.Help()
         return
      }
      Print()
   },
}
...
复制代码

测试:

$ .\go-cobra.exe hi                                                             
Usage:
  hello hi [flags]
Usage:
  hello hi [flags]
Flags:
      --address string    (default "Beijing")
      --age int           (default 1)
  -h, --help             help for hi
      --like strings
      --name string       (default "world")
复制代码

4 小总结

本文介绍了Cobra的最基本也是最常用的使用部分,但是Cobra仍然有很多优秀的操作值得我们学习。拜拜喽~


相关文章
|
3月前
|
Kubernetes 监控 Cloud Native
"解锁K8s新姿势!Cobra+Client-go强强联手,打造你的专属K8s监控神器,让资源优化与性能监控尽在掌握!"
【8月更文挑战第14天】在云原生领域,Kubernetes以出色的扩展性和定制化能力引领潮流。面对独特需求,自定义插件成为必要。本文通过Cobra与Client-go两大利器,打造一款监测特定标签Pods资源使用的K8s插件。Cobra简化CLI开发,Client-go则负责与K8s API交互。从初始化项目到实现查询逻辑,一步步引导你构建个性化工具,开启K8s集群智能化管理之旅。
53 2
|
6月前
|
Shell Linux Go
酷玩Go命令行工具—Cobra
酷玩Go命令行工具—Cobra
89 0
|
12月前
|
存储 JSON Go
Go 命令行框架: 构建强大的命令行工具
Go 命令行框架: 构建强大的命令行工具
|
Kubernetes NoSQL Go
Go 优秀库推荐 - 命令行工具 cobra
spf13/cobra 和 urfave/cli 是Go的2个优秀命令行工具:
747 0
Go 优秀库推荐 - 命令行工具 cobra
|
Kubernetes Unix Shell
Go 语言现代命令行框架 Cobra 详解
Go 语言现代命令行框架 Cobra 详解
1205 0
|
数据可视化 NoSQL 安全
Go实战之常用命令行工具(下)
Go实战之常用命令行工具
261 0
Go实战之常用命令行工具(下)
|
存储 缓存 JSON
Go实战之常用命令行工具(中)
Go实战之常用命令行工具
162 0
Go实战之常用命令行工具(中)
|
缓存 关系型数据库 MySQL
Go实战之常用命令行工具(上)
Go实战之常用命令行工具
459 0
Go实战之常用命令行工具(上)
|
3天前
|
存储 JSON 监控
Viper,一个Go语言配置管理神器!
Viper 是一个功能强大的 Go 语言配置管理库,支持从多种来源读取配置,包括文件、环境变量、远程配置中心等。本文详细介绍了 Viper 的核心特性和使用方法,包括从本地 YAML 文件和 Consul 远程配置中心读取配置的示例。Viper 的多来源配置、动态配置和轻松集成特性使其成为管理复杂应用配置的理想选择。
16 2