正文 

当前位置： 首页 > IT > java教程

golang命令行库cobra的使用(代码片段)

wangbin wangbin     2022-12-22     629

关键词：

简介

Cobra既是一个用来创建强大的现代CLI命令行的golang库，也是一个生成程序应用和命令行文件的程序。下面是Cobra使用的一个演示：

技术分享图片

Cobra提供的功能

  • 简易的子命令行模式，如 app server， app fetch等等
  • 完全兼容posix命令行模式
  • 嵌套子命令subcommand
  • 支持全局，局部，串联flags
  • 使用Cobra很容易的生成应用程序和命令，使用cobra create appname和cobra add cmdname
  • 如果命令输入错误，将提供智能建议，如 app srver，将提示srver没有，是否是app server
  • 自动生成commands和flags的帮助信息
  • 自动生成详细的help信息，如app help
  • 自动识别-h，--help帮助flag
  • 自动生成应用程序在bash下命令自动完成功能
  • 自动生成应用程序的man手册
  • 命令行别名
  • 自定义help和usage信息
  • 可选的紧密集成的viper apps

如何使用

上面所有列出的功能我没有一一去使用，下面我来简单介绍一下如何使用Cobra，基本能够满足一般命令行程序的需求，如果需要更多功能，可以研究一下源码github。

安装cobra

Cobra是非常容易使用的，使用go get来安装最新版本的库。当然这个库还是相对比较大的，可能需要安装它可能需要相当长的时间，这取决于你的速网。安装完成后，打开GOPATH目录，bin目录下应该有已经编译好的cobra.exe程序，当然你也可以使用源代码自己生成一个最新的cobra程序。

> go get -v github.com/spf13/cobra/cobra

使用cobra生成应用程序

假设现在我们要开发一个基于CLIs的命令程序，名字为demo。首先打开CMD，切换到GOPATH的src目录下[^1]，执行如下指令：
[^1]:cobra.exe只能在GOPATH目录下执行

src> ..incobra.exe init demo 
Your Cobra application is ready at
C:Usersliubo5Desktop	ranscoding_toolsrcdemo
Give it a try by going there and running `go run main.go`
Add commands to it by running `cobra add [cmdname]`

在src目录下会生成一个demo的文件夹，如下：

? demo
    ? cmd/
        root.go
    main.go

如果你的demo程序没有subcommands，那么cobra生成应用程序的操作就结束了。

如何实现没有子命令的CLIs程序

接下来就是可以继续demo的功能设计了。例如我在demo下面新建一个包，名称为imp。如下：

? demo
    ? cmd/
        root.go
    ? imp/
        imp.go
        imp_test.go
    main.go

imp.go文件的代码如下：

package imp

import(
    "fmt"
)

func Show(name string, age int) 
    fmt.Printf("My Name is %s, My age is %d
", name, age)

demo程序成命令行接收两个参数name和age，然后打印出来。打开cobra自动生成的main.go文件查看：

// Copyright © 2016 NAME HERE <EMAIL ADDRESS>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package main

import "demo/cmd"

func main() 
    cmd.Execute()

可以看出main函数执行cmd包，所以我们只需要在cmd包内调用imp包就能实现demo程序的需求。接着打开root.go文件查看：

// Copyright © 2016 NAME HERE <EMAIL ADDRESS>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package cmd

import (
    "fmt"
    "os"

    "github.com/spf13/cobra"
    "github.com/spf13/viper"
)

var cfgFile string

// RootCmd represents the base command when called without any subcommands
var RootCmd = &cobra.Command
    Use:   "demo",
    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 sets flags appropriately.
// This is called by main.main(). It only needs to happen once to the rootCmd.
func Execute() 
    if err := RootCmd.Execute(); err != nil 
        fmt.Println(err)
        os.Exit(-1)
    


func init() 
    cobra.OnInitialize(initConfig)

    // 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/.demo.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")


// initConfig reads in config file and ENV variables if set.
func initConfig() 
    if cfgFile != ""  // enable ability to specify config file via flag
        viper.SetConfigFile(cfgFile)
    

    viper.SetConfigName(".demo") // name of config file (without extension)
    viper.AddConfigPath("$HOME")  // adding home directory as first search path
    viper.AutomaticEnv()          // read in environment variables that match

    // If a config file is found, read it in.
    if err := viper.ReadInConfig(); err == nil 
        fmt.Println("Using config file:", viper.ConfigFileUsed())

从源代码来看cmd包进行了一些初始化操作并提供了Execute接口。十分简单，其中viper是cobra集成的配置文件读取的库，这里不需要使用，我们可以注释掉（不注释可能生成的应用程序很大约10M，这里没哟用到最好是注释掉）。cobra的所有命令都是通过cobra.Command这个结构体实现的。为了实现demo功能，显然我们需要修改RootCmd。修改后的代码如下：

// Copyright © 2016 NAME HERE <EMAIL ADDRESS>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package cmd

import (
    "fmt"
    "os"

    "github.com/spf13/cobra"
    //  "github.com/spf13/viper"
    "demo/imp"
)

//var cfgFile string
var name string
var age int

// RootCmd represents the base command when called without any subcommands
var RootCmd = &cobra.Command
    Use:   "demo",
    Short: "A test demo",
    Long:  `Demo is a test appcation for print things`,
    // Uncomment the following line if your bare application
    // has an action associated with it:
    Run: func(cmd *cobra.Command, args []string) 
        if len(name) == 0 
            cmd.Help()
            return
        
        imp.Show(name, age)
    ,


// Execute adds all child commands to the root command sets flags appropriately.
// This is called by main.main(). It only needs to happen once to the rootCmd.
func Execute() 
    if err := RootCmd.Execute(); err != nil 
        fmt.Println(err)
        os.Exit(-1)
    


func init() 
    //  cobra.OnInitialize(initConfig)

    // 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/.demo.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")
    RootCmd.Flags().StringVarP(&name, "name", "n", "", "person‘s name")
    RootCmd.Flags().IntVarP(&age, "age", "a", 0, "person‘s age")


// initConfig reads in config file and ENV variables if set.
//func initConfig() 
//  if cfgFile != ""  // enable ability to specify config file via flag
//      viper.SetConfigFile(cfgFile)
//  

//  viper.SetConfigName(".demo") // name of config file (without extension)
//  viper.AddConfigPath("$HOME") // adding home directory as first search path
//  viper.AutomaticEnv()         // read in environment variables that match

//  // If a config file is found, read it in.
//  if err := viper.ReadInConfig(); err == nil 
//      fmt.Println("Using config file:", viper.ConfigFileUsed())
//  
//

到此demo的功能已经实现了，我们编译运行一下看看实际效果：

>demo.exe
Demo is a test appcation for print things

Usage:
  demo [flags]

Flags:
  -a, --age int       person‘s age
  -h, --help          help for demo
  -n, --name string   person‘s name
>demo -n borey --age 26
My Name is borey, My age is 26

如何实现带有子命令的CLIs程序

在执行cobra.exe init demo之后，继续使用cobra为demo添加子命令test：

srcdemo>....incobra add test
test created at C:Usersliubo5Desktop	ranscoding_toolsrcdemocmd	est.go

在src目录下demo的文件夹下生成了一个cmd est.go文件，如下：

? demo
    ? cmd/
        root.go
        test.go
    main.go

接下来的操作就和上面修改root.go文件一样去配置test子命令。效果如下：

srcdemo>demo
Demo is a test appcation for print things

Usage:
  demo [flags]
  demo [command]

Available Commands:
  test        A brief description of your command

Flags:
  -a, --age int       person‘s age
  -h, --help          help for demo
  -n, --name string   person‘s name

Use "demo [command] --help" for more information about a command.

可以看出demo既支持直接使用标记flag，又能使用子命令

srcdemo>demo test -h
A longer description that spans multiple lines and likely contains examples
and usage of using your command. 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.

Usage:
  demo test [flags]

调用test命令输出信息，这里没有对默认信息进行修改。

srcdemo>demo tst
Error: unknown command "tst" for "demo"

Did you mean this?
        test

Run ‘demo --help‘ for usage.
unknown command "tst" for "demo"

Did you mean this?
        test

这是错误命令提示功能

OVER

Cobra的使用就介绍到这里，更新细节可去github详细研究一下。这里只是一个简单的使用入门介绍，如果有错误之处，敬请指出，谢谢～

go语言---小白入门-命令行库cobra的使用(代码片段)

...建强大的现代CLI应用程序的库，也是用于生成应用程序和命令文件的程序。Cobra提供的功能：简易的子命令行模式，如appserver，appfetch等等完全兼容posix命令行模式嵌套子命令subcommand支持全局，局部，串联flags使用Cobra很容易的生... 查看详情

golang命令行cobra妙用(代码片段)

...令行有吗？对于命令行则有command(命令)和flag（参数），golang自带了flag包，不过功能不够强大，这里我们使用第三方包cobracobra的使用具体用法可以参考官方文档，我就不细说了。妙 查看详情

golang:cobra包简介(代码片段)

Cobra是一个Golang包，它提供了简单的接口来创建命令行程序。同时，Cobra也是一个应用程序，用来生成应用框架，从而开发以Cobra为基础的应用。本文的演示环境为ubuntu18.04(下图来自互联网)。主要功能cobra的主要功能如下，可以说... 查看详情

go命令行库cobra的核心文件root.go

因为docker及Kubernetes都在用cobra库，所以记录一下。自定义的地方，高红标出。root.go/*Copyright©2019NAMEHERE<EMAILADDRESS>LicensedundertheApacheLicense,Version2.0(the"License");youmaynotusethisfileexceptincompliancewiththeLicense.YoumayobtainacopyoftheLicenseathtt... 查看详情

gocobra命令行工具总结(代码片段)

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

golang常用模块介绍(代码片段)

golang模块一、命令行库CobraCobra提供简单的接口来创建强大的现代化CLI接口，比如git与go工具。Cobra同时也是一个程序,用于创建CLI程序https://www.jianshu.com/p/7abe7cff5384二、client-goClient-go是kubernetes官方发布的调用K8SAPI的golang语言包，可... 查看详情

go的解析命令行库flag(代码片段)

简介flag和log一样是Go的标准库。flag用于解析命令行的选项，例如命令ls-al列出当前目录下所有文件和目录的详细信息，其中-al就是命令行选项。命令行选项在实际开发中很常用，特别是在一起命令行工具当中：redi... 查看详情

go的解析命令行库flag(代码片段)

简介flag和log一样是Go的标准库。flag用于解析命令行的选项，例如命令ls-al列出当前目录下所有文件和目录的详细信息，其中-al就是命令行选项。命令行选项在实际开发中很常用，特别是在一起命令行工具当中：redi... 查看详情

gocobra初试(代码片段)

...samoreextensivelistofprojectsusingCobra.cobra是用来创建先进现代化命令行工具的库。k8s/Hugo/GithubCli都是用cobra创建的。cobra-clicobra-cli可以生成对应命令的代码，遵循cobra要求的代码风格和模式。如下的代码示例就是使用cobra-cli来进行的... 查看详情

go的解析命令行库flag(代码片段)

简介flag和log一样是Go的标准库。flag用于解析命令行的选项，例如命令ls-al列出当前目录下所有文件和目录的详细信息，其中-al就是命令行选项。命令行选项在实际开发中很常用，特别是在一起命令行工具当中：redi... 查看详情

go的解析命令行库go-flags(代码片段)

...据类型。为了解决这些问题，出现了不少第三方解析命令行选项的库，go-flags就是其中一个。go-flags提供了比标准库flag更多的选项，它利用结构体的标签tag和反射提供了一个方便、简洁的接口。除了基本的功能，... 查看详情

命令行工具cobra的使用

安装cobragoget-vgithub.com/spf13/cobra/cobra切换到GOPATH的src目录下并创建一个新文件夹：democd$GOPATH/srcmkdirdemocddemo初始cobra$../../bin/cobraCobraisaCLIlibraryforGothatempowersapplications.Thisapplicationisatooltogener 查看详情

go的解析命令行库go-flags(代码片段)

...据类型。为了解决这些问题，出现了不少第三方解析命令行选项的库，go-flags就是其中一个。go-flags提供了比标准库flag更多的选项，它利用结构体的标签tag和反射提供了一个方便、简洁的接口。除了基本的功能，... 查看详情

go的解析命令行库go-flags(代码片段)

...据类型。为了解决这些问题，出现了不少第三方解析命令行选项的库，go-flags就是其中一个。go-flags提供了比标准库flag更多的选项，它利用结构体的标签tag和反射提供了一个方便、简洁的接口。除了基本的功能，... 查看详情

golang使用带命令行参数的文件io(代码片段)

查看详情

go库cobra现代化的命令行框架

go库Cobra现代化的命令行框架文章目录​​go库Cobra现代化的命令行框架​​​​1.简介​​​​2.主要功能​​​​3.应用举例​​​​4.Cobra安装​​​​5.使用Cobra库创建命令​​​​5.1创建rootCmd​​​​5.2创建main.go​​​​5.3... 查看详情

golang使用一个命令获取您的公共和私有ip地址(代码片段)

查看详情

golang性能测试框架k6源码分析

...本使用js，更加适合自动化的架构。k6启动的框架是使用golang的cli标准框架cobra，入口函数进入cobra框架后，我们直接查看getRunCmd，这个是命令run的入口，主要工作都是从这里开始。重点关注初始化Runner，这个是通过js脚本，使用go... 查看详情