[[387894]]

本文轉載自微信公眾號「程序員工具集」，作者狐貍。轉載本文請聯系程序員工具集公眾號。

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使用

目錄結構

image-20210218100009073

基命令

創建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