写点什么

cobra- 强大的 CLI 应用程序库

用户头像
happlyfox
关注
发布于: 2021 年 02 月 24 日

cobra 介绍

Cobra 是一个用于创建强大的现代 CLI 应用程序的库,也是一个用于生成应用程序和命令文件的程序。


Cobra 用于许多 Go 项目,如Kubernetes、[Hugo](https://gohugo.io/)和[Github CLI](https://github.com/cli/cli)等。[此列表](https://github.com/spf13/cobra/blob/master/projectsusingcobra.md)包含了使用 Cobra 的更广泛的项目列表。


概述


Cobra 是一个库,提供了一个简单的界面来创建功能强大的现代 CLI 界面,类似于 git&go 工具。


Cobra 还是一个应用程序,它将生成您的应用程序框架以快速开发基于 Cobra 的应用程序。


眼镜蛇提供:


  • 简单易用的基于子的 CLI:app serverapp fetch等。

  • 完全兼容 POSIX 的标志(包括短版和长版)

  • 嵌套子命令

  • 全局,局部和级联标志

  • 易产生的应用程序和命令与cobra init appnamecobra 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 Gonne

Flags:

-h, --help help for gonne

Use "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


发布于: 2021 年 02 月 24 日阅读数: 12
用户头像

happlyfox

关注

公众号 程序员工具集 2021.02.18 加入

博客 [www.zhouhuibo.club] 分享优秀的开源项目、学习资源和常用工具。谈论新闻热点、职场经验、学习感悟。共同进步!

评论

发布
暂无评论
cobra-强大的CLI应用程序库