关于我
cobra介绍
Cobra是一个用于创建强大的现代CLI应用程序的库,也是一个用于生成应用程序和命令文件的程序。
Cobra用于许多Go项目,如Kubernetes、Hugo和Github CLI等。此列表包含了使用Cobra的更广泛的项目列表。
概述
Cobra是一个库,提供了一个简单的界面来创建功能强大的现代CLI界面,类似于git&go工具。
Cobra还是一个应用程序,它将生成您的应用程序框架以快速开发基于Cobra的应用程序。
眼镜蛇提供:
- 简单易用的基于子的CLI:
app server
,app fetch
等。 - 完全兼容POSIX的标志(包括短版和长版)
- 嵌套子命令
- 全局,局部和级联标志
- 易产生的应用程序和命令与
cobra init appname
&cobra add cmdname
- 明智的建议(
app srver
……是您的意思app server
吗?) - 自动生成命令和标志的帮助
- 自动帮助标志识别
-h
,--help
等等。 - 为您的应用程序自动生成的外壳自动完成功能(bash,zsh,fish,powershell)
- 自动为您的应用程序生成手册页
- 命令别名,以便您可以更改内容而不会破坏它们
- 定义自己的帮助,用法等的灵活性。
- 可选与viper紧密集成,可用于12因子应用程序
概念
Cobra建立在命令,参数和标志的结构上。
命令代表动作,Args是事物,Flags是这些动作的修饰符。
最好的应用程序在使用时读起来就像句子,结果,用户直观地知道如何与之交互。
遵循的模式是 APPNAME VERB NOUN --ADJECTIVE.
或 APPNAME COMMAND ARG --FLAG
一些真实的例子可以更好地说明这一点。
在以下示例中,“服务器”是命令,“端口”是标志:
hugo server --port=1313
在此命令中,我们告诉Git克隆url的内容。
git clone URL --bare
安装
使用眼镜蛇很容易。首先,使用go get
来安装该库的最新版本。此命令将安装cobra
生成器可执行文件以及库及其依赖项:
go get -u github.com/spf13/cobra
Next, include Cobra in your application:
import "github.com/spf13/cobra"
入门
欢迎您提供自己的组织,但是通常基于Cobra的应用程序将遵循以下组织结构:
▾ appName/
▾ cmd/
add.go
your.go
commands.go
here.go
main.go
在Cobra应用程序中,通常main.go文件非常裸露。它有一个目的:初始化眼镜蛇
package main
import (
"{pathToYourApp}/cmd"
)
func main() {
cmd.Execute()
}
Cobra使用
目录结构
基命令
创建root.go
文件,定义一个基命令
package cmd
import (
"github.com/spf13/cobra"
)
var RootCmd = &cobra.Command{
Use: "gonne",
Run: func(cmd *cobra.Command, args []string) {
if len(args) == 0 {
cmd.Help()
return
}
},
}
在main函数中使用命令,就是这么简单
main.go
文件
package main
import (
"demo-practice/cobra/cmd"
"fmt"
"os"
)
func main() {
if err := cmd.RootCmd.Execute(); err != nil {
fmt.Println(err)
os.Exit(1)
}
}
在windows环境下编译
go build -o gonne.exe
执行命令查看效果,输出内容如下所示
gonne.exe
Usage:
gonne [flags]
gonne [command]Available Commands:
help Help about any command
version Print the version number of GonneFlags:
-h, --help help for gonneUse "gonne [command] --help" for more information about a command.
子命令
在基命令上增加子命令也相当简单,根本无需在基命令和main方法中写任何代码,只需新建一个go文件,多个子命令间也是相互独立的,多么优雅的代码,告别各种case
增加一个版本命令用法:
在cmd目录下增加一个version.go文件,内容如下
package cmd
import "github.com/spf13/cobra"
func init() {
RootCmd.AddCommand(versionCmd)
}
var versionCmd = &cobra.Command{
Use: "version",
Short: "Print the version number of Gonne",
Run: func(cmd *cobra.Command, args []string) {
println("gonne version is 0.0.1")
},
}
init()函数将此命令添加到基命令下
编译后执行 gonne version
gonne version is 0.0.1
资源列表
https://github.com/spf13/cobra
推荐阅读
END
欢迎关注公众号 程序员工具集
致力于分享优秀的开源项目、学习资源 、常用工具
回复关键词“关注礼包”,送你一份最全的程序员技能图谱。