go Cobra命令行工具入门教程

 更新时间:2022年06月24日 10:53:03   作者:Go和分布式IM  
Cobra是一个用Go语言实现的命令行工具并且现在正在被很多项目使用,例如:Kubernetes、Hugo和Github CLI等,通过使用Cobra,我们可以快速的创建命令行工具,特别适合写测试脚本,各种服务的Admin CLI等,本文重点给大家介绍go Cobra命令行工具,感兴趣的朋友一起看看吧

简介

Github:https://github.com/spf13/

cobraStar:26.5K

Cobra是一个用Go语言实现的命令行工具。并且现在正在被很多项目使用,例如:Kubernetes、Hugo和Github CLI等。通过使用Cobra,我们可以快速的创建命令行工具,特别适合写测试脚本,各种服务的Admin CLI等。比如 Mattermost 项目,就写了很多 Admin CLI:

为什么需要cobra

我们看一个简单的demo使用前

package main
  
import (
    "flag"
    "fmt"
)
  
func main() {
    flag.Parse()
  
    args := flag.Args()
    if len(args) <= 0 {
        fmt.Println("Usage:  admin-cli [command]")
        return
    }
  
    switch args[0] {
    case "help":
        // ...
    case "export":
        //...
        if len(args) == 3 { // 导出到文件
            // todo
        } else if len(args) == 2 { // 导出...
            // todo
        }
    default:
        //...
    }
}

使用后

package main
import (
    "fmt"
    "github.com/spf13/cobra"
    "os"
)
// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
    Use:   "api",
    Short: "A brief description of your application",
    Long:  `A longer description `,
}
// 命令一
var mockMsgCmd = &cobra.Command{
    Use:   "mockMsg",
    Short: "批量发送测试文本消息",
    Long:  ``,
    Run: func(cmd *cobra.Command, args []string) {
        fmt.Println("mockMsg called")
    },
}
// 命令二
var exportCmd = &cobra.Command{
    Use:   "export",
    Short: "导出数据",
    Long:  ``,
    Run: func(cmd *cobra.Command, args []string) {
        fmt.Println("export called")
    },
}
func Execute() {
    err := rootCmd.Execute()
    if err != nil {
        os.Exit(1)
    }
}
func init() {
    rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
    rootCmd.AddCommand(mockMsgCmd)
    rootCmd.AddCommand(exportCmd)
    exportCmd.Flags().StringP("out", "k", "./backup", "导出路径")
}
func main() {
    Execute()
}

运行:

$ go run main.go
A longer description
Usage:
  api [command]
Available Commands:
  completion  Generate the autocompletion script for the specified shell
  export      导出数据
  help        Help about any command
  mockMsg     批量发送测试文本消息
Flags:
  -h, --help     help for api
  -t, --toggle   Help message for toggle
Use "api [command] --help" for more information about a command.

发现了吗?你不用再处理各种参数组合了,从此释放了出来,只需要写自己的业务逻辑即可!

基本概念

Cobra由三部分组成:

  • 命令(Commands ):代表行为。命令是程序的中心点,程序的每个功能都应该可以通过命令进行交互,一个命令可以有任意个子命令。
  • 参数(Args):命令的参数
  • 标志(Flags):修饰命令。它修饰命令该如何完成。

官方推荐命令格式为:

$ ./appName command args --Flag

如 hugo server --port=1313 :

  • appName: hugo 
  • command: server 
  • flag: port

安装

Go pkg

添加依赖

$ go get -u github.com/spf13/cobra@latest

导入即可:

import "github.com/spf13/cobra"

命令行工具

建议安装命令行工具 `cobra-cli` ,以方便快速创建cobra项目,增加command等。

# 命令行工具
$ go install github.com/spf13/cobra-cli@latest

安装完成之后,执行 `cobra-cli --help` (请确保GOBIN已配置),输出下列信息则代表成功:

$ cobra-cli --help
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.
  
Usage:
  cobra-cli [command]
  
Available Commands:
  add         Add a command to a Cobra Application
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  init        Initialize a Cobra Application
  
Flags:
  -a, --author string    author name for copyright attribution (default "YOUR NAME")
      --config string    config file (default is $HOME/.cobra.yaml)
  -h, --help             help for cobra-cli
  -l, --license string   name of license for the project
      --viper            use Viper for configuration
  
Use "cobra-cli [command] --help" for more information about a command.

  

入门实践

新建cobra命令行程序

安装了cobra-cli工具之后,执行 init 初始化创建项目:

$ cobra-cli init

此时,在当前目录自动生成如下文件:

├── LICENSE
├── cmd
│   └── root.go
└── main.go

main.go:

package main
  
import "tools/api/cmd"
  
func main() {
   cmd.Execute()
}
root.go(有删减):
package cmd
import (
   "fmt"
   "github.com/spf13/cobra"
)
// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
   Use:   "api",
   Short: "A brief description of your application",
   Long:  `A longer description `,
   //Run: func(cmd *cobra.Command, args []string) {
   // fmt.Println("api called")
   //},
}
// 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() {
   // 全局flag
   // rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.api.yaml)")
   // local flag,暂不知道用处
   rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
}

此时运行,不用指定参数,会执行rootCmd,打印使用说明:

$ go build
$ ./api

输出:

A longer description
Usage:
  api [command]
Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
Flags:
  -h, --help     help for api
  -t, --toggle   Help message for toggle
Use "api [command] --help" for more information about a command.  

命令构成

分析上面的默认输出:

  • Available Commands:代表可以执行的命令。比如./api connect
  • Flags:是参数。比如./api connect --ip=127.0.0.1:6379,--ip就是flag,127.0.0.1:6379就是flag的值。

新增命令

我们来新增一个命令试试,这也是命令行程序的魅力,通过不同的参数执行不同的动作。

语法:

$ cobra-cli add [command]

比如:

$ cobra-cli add mock-msg
mockMsg created at /Users/xxx/repo/tools/api

此时,在cmd下会多一个文件(mock_msg.go),内容如下:

package cmd
import (
   "fmt"
   "github.com/spf13/cobra"
)
var mockMsgCmd = &cobra.Command{
   Use:   "mockMsg",
   Short: "A brief description of your command",
   Long: `mock msg command`,
   Run: func(cmd *cobra.Command, args []string) {
      fmt.Println("mockMsg called")
   },
}
func init() {
   rootCmd.AddCommand(mockMsgCmd)
}

再执行rootCmd:

$ go build
$ ./api

会发现,多了一个命令:

// ...
Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  mockMsg     A brief description of your command
// ...

执行mocMsg命令:

$ ./api mockMsg
mockMsg called

此时,就可以在生成的mock_msg.go:Run() 函数中,放你自己的业务逻辑代码了。

如何显示自己的命令用法

上面新增了一个命令mockMsg,通过 ./api help 打印了命令和help,但是 `Use` 里面指定的内容打印到哪里去了呢?这个时候,需要针对Command在指定help,此时就能打印这个命令的具体用法了。

./api mockMsg help
批量生产mq消息
  
Usage:
  benchmark mockmsg [flags]
  
Flags:
  -g, --goroutine int32   并发routine数量 (default 1)
  -h, --help              help for mockmsg
  -p, --packet int32      每个routine一秒写入mq的数量 (default 20)

<br>-g和-p是新增的2个flag:

func init() {
   mockmsgCmd.Flags().Int32P("goroutine", "g", 1, "并发routine数量")
   mockmsgCmd.Flags().Int32P("packet", "p", 20, "每个routine一秒写入mq的数量")
  
   rootCmd.AddCommand(mockmsgCmd)
}

获取这2个值:

// mockmsgCmd represents the mockmsg command
var mockmsgCmd = &cobra.Command{
   Use:   "mockmsg",
   Short: "批量生产mq消息",
   Run: func(cmd *cobra.Command, args []string) {
      // 这里要写全名
      g, _ := cmd.Flags().GetInt32("goroutine")
      p, _ := cmd.Flags().GetInt32("packet")
      fmt.Println("mockmsg called,flags:g=", g, ",p=", p, ",args:", args)
   },
}

执行:

$ go run main.go mockmsg -p 322 -g 5 args1 args2
mockmsg called,flags:g= 5 ,p= 322 ,args: [args1 args2]

总结

我们通过一个例子,介绍了使用cobra带来的好处。通过一个完整的入门实践,演示了创建项目、添加命令和使用的一些示例,希望对你有所帮助!

参考:

https://blog.csdn.net/qq_31639829/article/details/118889580

https://github.com/mattermost/mattermost-server

到此这篇关于go Cobra命令行工具入门的文章就介绍到这了,更多相关go Cobra命令行工具内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Go语言中扫描Redis中大量key的示例代码

    Go语言中扫描Redis中大量key的示例代码

    在 Redis 中,当我们需要遍历大量的键时,直接使用 KEYS 命令会面临性能瓶颈,尤其是在键数量非常多的情况下,今天,我们将通过两个示例代码,详细讲解如何在 Go 语言中使用 SCAN 命令遍历 Redis 键,需要的朋友可以参考下
    2024-08-08
  • Golang中处理import自定义包出错问题的解决办法

    Golang中处理import自定义包出错问题的解决办法

    最近开始使用Go/GoLand在import自定义包时出现各种状况,下面这篇文章主要给大家介绍了关于Golang中处理import自定义包出错问题的解决办法,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2023-11-11
  • Go gRPC服务客户端流式RPC教程

    Go gRPC服务客户端流式RPC教程

    这篇文章主要为大家介绍了Go gRPC服务客户端流式RPC教程示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-06-06
  • 详解Go操作supervisor xml rpc接口及注意事项

    详解Go操作supervisor xml rpc接口及注意事项

    这篇文章主要介绍了Go操作supervisor xml rpc接口及注意事项,管理web,在配置文件中配置相关信息,通过go-supervisor的处理库进行操作,需要的朋友可以参考下
    2021-09-09
  • Mac GoLand打不开(闪退)也不报错的解决方案

    Mac GoLand打不开(闪退)也不报错的解决方案

    这篇文章主要介绍了Mac GoLand打不开(闪退)也不报错的解决方案,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-04-04
  • golang int64转int的方法

    golang int64转int的方法

    这篇文章主要介绍了golang int64转int,本文给大家提供两种方法 ,将 golang int64 转换为golang int,结合实例代码给大家分享转换方法,需要的朋友可以参考下
    2023-01-01
  • 深入理解Golang的反射reflect示例

    深入理解Golang的反射reflect示例

    本文主要介绍了Golang的反射reflect示例,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-01-01
  • 详解如何在golang镜像中设置指定时区

    详解如何在golang镜像中设置指定时区

    这篇文章主要为大家详细介绍了如何在golang镜像中设置指定时区,文中的示例代码讲解详细,具有一定的借鉴价值,感兴趣的可以了解一下
    2023-04-04
  • Go语言学习之时间函数使用详解

    Go语言学习之时间函数使用详解

    这篇文章主要为大家详细介绍了Go语言中时间函数的使用方法,文中的示例代码讲解详细,对我们学习Go语言有一定的帮助,需要的可以参考一下
    2022-04-04
  • 源码分析Golang log是如何实现的

    源码分析Golang log是如何实现的

    go语言的log包提供了简单的日志记录功能,允许开发者在应用程序中记录重要的信息、错误、警告等,log包是Go标准库的一部分,因此,使用它不需要安装额外的第三方库,本文给大家源码分析了Golang log是如何实现的,需要的朋友可以参考下
    2024-03-03

最新评论