草庐IT

Go cobra 库学习

kina100 2023-04-09 原文

cobra既是一个用于创建强大现代CLI应用程序的库,也是一个生成应用程序和命令文件的程序。cobra被用在很多go语言的项目中,比如 Kubernetes、Docker、Istio、ETCD、Hugo、Github CLI等等


其实简单的来说,cobra就是一个自定义命令工具,我们经常使用一些命令来构建项目,但是这些命令都是go自带的,你想写自己的命令就可以使用cobra库来试一试。

一,安装

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

二,简单的cobra项目

先构建一个简单的cobra命令,以此来熟悉cobra是怎么用的

创建一个cmd目录,在目录里创建一个myOrder.go,实际上这个名字可以随便命名,一般来说,你创建的啥命令就写啥名字,这不是为了好找么。

package cmd

import (
	"fmt"
	"github.com/spf13/cobra"
)

var rootCmd = cobra.Command{
	// 命令的名称
	Use: "myOrder",
	// 剪短介绍
	Short: "这是一个我的私有命令",
	// 详细介绍
	Long: "自定义私有命令,主要是想测试下这玩意能不能用",
	// 普通运行,如果需要返回error要使用RUNE
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println("这是一条myOrder命令的反馈,反正啥也没处理")
	},
}

func Execute() {
	if err := rootCmd.Execute(); err != nil {
		fmt.Println("这里有错误", err)
	}
}

然后在main.go 入口里运行Execute即可

main.go ↓

package main

import "cobraTest/cmd"

func main() {
	cmd.Execute()
}

cobraTest是这个项目的名字,cmd是刚才创建的那个包(目录)。

此时是不能直接像往常一样go run的,要先构建为可执行文件,在windows上就是exe

go build

go build之后会发现目录里多出了一个可执行文件,

 这时候我们可以进行简单的测试

三,测试

执行可执行文件,并且带上我们刚才的那个命令

.\cobraTest.exe myOrder

 这就是刚才写的那个RUN 里面的运行结果

四,增加flag参数

package cmd

import (
	"fmt"
	"github.com/spf13/cobra"
)

var rootCmd = cobra.Command{
	// 命令的名称
	Use: "myOrder",
	// 剪短介绍
	Short: "这是一个我的私有命令",
	// 详细介绍
	Long: "自定义私有命令,主要是想测试下这玩意能不能用",
	// 普通运行,如果需要返回error要使用RUNE
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println("这是一条myOrder命令的反馈,反正啥也没处理")
        // 读取第一个flag 参数
		getString, _ := cmd.Flags().GetString("hahaha")
		fmt.Println(getString)
        // 读取第二个flag 参数
		getString, _ = cmd.Flags().GetString("heiheihei")
		fmt.Println(getString)
	},
}

func Execute() {
    // 增加一个flag 参数
    // flag参数的名称,示例值,flag参数解释
	rootCmd.PersistentFlags().String("hahaha", "", "随便写点啥吧")
    // 再增加一个flag 参数
	rootCmd.Flags().String("heiheihei", "", "输入一些东西")

	if err := rootCmd.Execute(); err != nil {
		fmt.Println("这里有错误", err)
	}
}

在设定完rootCmd后,就可以直接给rootCmd结构体增加flag参数,并在run里面读取出来,修改代码后要重新go build,之后执行命令的时候,加上flag参数

.\cobraTest.exe myOrder --hahaha 哈哈哈 --heiheihei 嘿嘿嘿

五,额外命令

有的文章说这是子命令,其实是不恰当的,这是为了让一个工程可以有多条命令,而无需生成多个可执行文件。

 构建两个命令,并在main.go里面写一个根命令

firstOrder.go ↓

package cmd

import (
	"fmt"
	"github.com/spf13/cobra"
)

// 大写可用于外部访问
var FirstCmd = cobra.Command{
	// 命令的名称
	Use: "firstOrder",
	// 剪短介绍
	Short: "1号命令",
	// 普通运行,如果需要返回error要使用RUNE
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println("1号命令可以执行")
	},
}

secondOrder.go ↓

package cmd

import (
	"fmt"
	"github.com/spf13/cobra"
)

var SecondCmd = cobra.Command{
	// 命令的名称
	Use: "secondOrder",
	// 剪短介绍
	Short: "2号命令",
	// 普通运行,如果需要返回error要使用RUNE
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println("2号命令可以执行")

	},
}

main.go ↓

package main

import (
	"cobraTest/cmd"
	"fmt"
	"github.com/spf13/cobra"
)

func main() {
	rootCmd := cobra.Command{
		Use:              "rootOrder",
		Short:            "根命令",
		TraverseChildren: true,
	}
	// 把这两条命令加入到根命令里面
	rootCmd.AddCommand(&cmd.FirstCmd)
	rootCmd.AddCommand(&cmd.SecondCmd)
	if err := rootCmd.Execute(); err != nil {
		fmt.Println("Could not run command")
	}
}

执行go build

 

有关Go cobra 库学习的更多相关文章

  1. LC滤波器设计学习笔记(一)滤波电路入门 - 2

    目录前言滤波电路科普主要分类实际情况单位的概念常用评价参数函数型滤波器简单分析滤波电路构成低通滤波器RC低通滤波器RL低通滤波器高通滤波器RC高通滤波器RL高通滤波器部分摘自《LC滤波器设计与制作》,侵权删。前言最近需要学习放大电路和滤波电路,但是由于只在之前做音乐频谱分析仪的时候简单了解过一点点运放,所以也是相当从零开始学习了。滤波电路科普主要分类滤波器:主要是从不同频率的成分中提取出特定频率的信号。有源滤波器:由RC元件与运算放大器组成的滤波器。可滤除某一次或多次谐波,最普通易于采用的无源滤波器结构是将电感与电容串联,可对主要次谐波(3、5、7)构成低阻抗旁路。无源滤波器:无源滤波器,又称

  2. CAN协议的学习与理解 - 2

    最近在学习CAN,记录一下,也供大家参考交流。推荐几个我觉得很好的CAN学习,本文也是在看了他们的好文之后做的笔记首先是瑞萨的CAN入门,真的通透;秀!靠这篇我竟然2天理解了CAN协议!实战STM32F4CAN!原文链接:https://blog.csdn.net/XiaoXiaoPengBo/article/details/116206252CAN详解(小白教程)原文链接:https://blog.csdn.net/xwwwj/article/details/105372234一篇易懂的CAN通讯协议指南1一篇易懂的CAN通讯协议指南1-知乎(zhihu.com)视频推荐CAN总线个人知识总

  3. 深度学习部署:Windows安装pycocotools报错解决方法 - 2

    深度学习部署:Windows安装pycocotools报错解决方法1.pycocotools库的简介2.pycocotools安装的坑3.解决办法更多Ai资讯:公主号AiCharm本系列是作者在跑一些深度学习实例时,遇到的各种各样的问题及解决办法,希望能够帮助到大家。ERROR:Commanderroredoutwithexitstatus1:'D:\Anaconda3\python.exe'-u-c'importsys,setuptools,tokenize;sys.argv[0]='"'"'C:\\Users\\46653\\AppData\\Local\\Temp\\pip-instal

  4. ruby - 我正在学习编程并选择了 Ruby。我应该升级到 Ruby 1.9 吗? - 2

    我完全不是程序员,正在学习使用Ruby和Rails框架进行编程。我目前正在使用Ruby1.8.7和Rails3.0.3,但我想知道我是否应该升级到Ruby1.9,因为我真的没有任何升级的“遗留”成本。缺点是什么?我是否会遇到与普通gem的兼容性问题,或者甚至其他我不太了解甚至无法预料的问题? 最佳答案 你应该升级。不要坚持从1.8.7开始。如果您发现不支持1.9.2的gem,请避免使用它们(因为它们很可能不被维护)。如果您对gem是否兼容1.9.2有任何疑问,您可以在以下位置查看:http://www.railsplugins.or

  5. ruby - 我如何学习 ruby​​ 的正则表达式? - 2

    如何学习ruby​​的正则表达式?(对于假人) 最佳答案 http://www.rubular.com/在Ruby中使用正则表达式时是一个很棒的工具,因为它可以立即将结果可视化。 关于ruby-我如何学习ruby​​的正则表达式?,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.com/questions/1881231/

  6. 深度学习12. CNN经典网络 VGG16 - 2

    深度学习12.CNN经典网络VGG16一、简介1.VGG来源2.VGG分类3.不同模型的参数数量4.3x3卷积核的好处5.关于学习率调度6.批归一化二、VGG16层分析1.层划分2.参数展开过程图解3.参数传递示例4.VGG16各层参数数量三、代码分析1.VGG16模型定义2.训练3.测试一、简介1.VGG来源VGG(VisualGeometryGroup)是一个视觉几何组在2014年提出的深度卷积神经网络架构。VGG在2014年ImageNet图像分类竞赛亚军,定位竞赛冠军;VGG网络采用连续的小卷积核(3x3)和池化层构建深度神经网络,网络深度可以达到16层或19层,其中VGG16和VGG

  7. 机器学习——时间序列ARIMA模型(四):自相关函数ACF和偏自相关函数PACF用于判断ARIMA模型中p、q参数取值 - 2

    文章目录1、自相关函数ACF2、偏自相关函数PACF3、ARIMA(p,d,q)的阶数判断4、代码实现1、引入所需依赖2、数据读取与处理3、一阶差分与绘图4、ACF5、PACF1、自相关函数ACF自相关函数反映了同一序列在不同时序的取值之间的相关性。公式:ACF(k)=ρk=Cov(yt,yt−k)Var(yt)ACF(k)=\rho_{k}=\frac{Cov(y_{t},y_{t-k})}{Var(y_{t})}ACF(k)=ρk​=Var(yt​)Cov(yt​,yt−k​)​其中分子用于求协方差矩阵,分母用于计算样本方差。求出的ACF值为[-1,1]。但对于一个平稳的AR模型,求出其滞

  8. Unity Shader 学习笔记(5)Shader变体、Shader属性定义技巧、自定义材质面板 - 2

    写在之前Shader变体、Shader属性定义技巧、自定义材质面板,这三个知识点任何一个单拿出来都是一套知识体系,不能一概而论,本文章目的在于将学习和实际工作中遇见的问题进行总结,类似于网络笔记之用,方便后续回顾查看,如有以偏概全、不祥不尽之处,还望海涵。1、Shader变体先看一段代码......Properties{ [KeywordEnum(on,off)]USL_USE_COL("IsUseColorMixTex?",int)=0 [Toggle(IS_RED_ON)]_IsRed("IsRed?",int)=0}......//中间省略,后续会有完整代码 #pragmamulti_c

  9. ruby-on-rails - 这个 C 和 PHP 程序员如何学习 Ruby 和 Rails? - 2

    按照目前的情况,这个问题不适合我们的问答形式。我们希望答案得到事实、引用或专业知识的支持,但这个问题可能会引发辩论、争论、投票或扩展讨论。如果您觉得这个问题可以改进并可能重新打开,visitthehelpcenter指导。关闭9年前。我来自C、php和bash背景,很容易学习,因为它们都有相同的C结构,我可以将其与我已经知道的联系起来。然后2年前我学了Python并且学得很好,Python对我来说比Ruby更容易学。然后从去年开始,我一直在尝试学习Ruby,然后是Rails,我承认,直到现在我还是学不会,讽刺的是那些打着简单易学的烙印,但是对于我这样一个老练的程序员来说,我只是无法将它

  10. jquery - 使用 Rails 3 学习 Ajax 的资源 - 2

    按照目前的情况,这个问题不适合我们的问答形式。我们希望答案得到事实、引用或专业知识的支持,但这个问题可能会引发辩论、争论、投票或扩展讨论。如果您觉得这个问题可以改进并可能重新打开,visitthehelpcenter指导。关闭10年前。有没有学习Ajax(jQuery)和Rails3的好资源?

随机推荐