建站
咨詢
售后
建站咨詢
新聞中心
本文轉(zhuǎn)載自微信公眾號「程序員工具集」，作者狐貍。轉(zhuǎn)載本文請聯(lián)系程序員工具集公眾號。
cobra介紹
Cobra是一個用于創(chuàng)建強(qiáng)大的現(xiàn)代CLI應(yīng)用程序的庫，也是一個用于生成應(yīng)用程序和命令文件的程序。
Cobra用于許多Go項目，如Kubernetes、Hugo和Github CLI等。此列表包含了使用Cobra的更廣泛的項目列表。
概述
Cobra是一個庫，提供了一個簡單的界面來創(chuàng)建功能強(qiáng)大的現(xiàn)代CLI界面，類似于git&go工具。
Cobra還是一個應(yīng)用程序，它將生成您的應(yīng)用程序框架以快速開發(fā)基于Cobra的應(yīng)用程序。
眼鏡蛇提供：
- 簡單易用的基于子的CLI：app server，app fetch等。
- 完全兼容POSIX的標(biāo)志(包括短版和長版)
- 嵌套子命令
- 全局，局部和級聯(lián)標(biāo)志
- 易產(chǎn)生的應(yīng)用程序和命令與cobra init appname&cobra add cmdname
- 明智的建議(app srver……是您的意思app server嗎?)
- 自動生成命令和標(biāo)志的幫助
- 自動幫助標(biāo)志識別-h，--help等等。
- 為您的應(yīng)用程序自動生成的外殼自動完成功能(bash，zsh，fish，powershell)
- 自動為您的應(yīng)用程序生成手冊頁
- 命令別名，以便您可以更改內(nèi)容而不會破壞它們
- 定義自己的幫助，用法等的靈活性。
- 可選與viper緊密集成，可用于12因子應(yīng)用程序
概念
Cobra建立在命令，參數(shù)和標(biāo)志的結(jié)構(gòu)上。
命令代表動作，Args是事物，F(xiàn)lags是這些動作的修飾符。
最好的應(yīng)用程序在使用時讀起來就像句子，結(jié)果，用戶直觀地知道如何與之交互。
遵循的模式是 APPNAME VERB NOUN --ADJECTIVE. 或 APPNAME COMMAND ARG --FLAG
一些真實的例子可以更好地說明這一點。
在以下示例中，“服務(wù)器”是命令，“端口”是標(biāo)志：
- hugo server --port=1313
在此命令中，我們告訴Git克隆url的內(nèi)容。
- git clone URL --bare
安裝
使用眼鏡蛇很容易。首先，使用go get來安裝該庫的最新版本。此命令將安裝cobra生成器可執(zhí)行文件以及庫及其依賴項：
- go get -u github.com/spf13/cobra
Next, include Cobra in your application:
- import "github.com/spf13/cobra"
入門
歡迎您提供自己的組織，但是通?；贑obra的應(yīng)用程序?qū)⒆裱韵陆M織結(jié)構(gòu)：
- ? appName/
- ? cmd/
- add.go
- your.go
- commands.go
- here.go
- main.go
在Cobra應(yīng)用程序中，通常main.go文件非常裸露。它有一個目的：初始化眼鏡蛇
- package main
- import (
- "{pathToYourApp}/cmd"
- )
- func main() {
- cmd.Execute()
- }
Cobra使用
目錄結(jié)構(gòu)
image-20210218100009073
基命令
創(chuàng)建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函數(shù)中使用命令，就是這么簡單
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環(huán)境下編譯
- go build -o gonne.exe
執(zhí)行命令查看效果，輸出內(nèi)容如下所示
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.
子命令
在基命令上增加子命令也相當(dāng)簡單，根本無需在基命令和main方法中寫任何代碼，只需新建一個go文件，多個子命令間也是相互獨立的，多么優(yōu)雅的代碼，告別各種case
增加一個版本命令用法：
在cmd目錄下增加一個version.go文件,內(nèi)容如下
- 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()函數(shù)將此命令添加到基命令下
編譯后執(zhí)行 gonne version
- gonne version is 0.0.1
資源列表
https://github.com/spf13/cobra
分享文章：Kubernetes的CLI是使用什么技術(shù)實現(xiàn)的？
當(dāng)前路徑：http://www.dlmjj.cn/article/ccegcpo.html
