玩轉(zhuǎn)Go命令行工具Cobra
不知大家有沒有在使用Git命令、Linux的yum命令、Go命令、Maven命令的時候感覺到非常的酷,比如你剛剛拿到一個Go的開源項目,初始化時只需要輸入go mod tidy
進行對依賴的下載,或者是git clone xxx
之后拉下來一個GitHub上的項目,mvn package
或者go build
就可以將整合項目打包成一個可執(zhí)行的文件,當然這些操作現(xiàn)在大多數(shù)都能通過可視化的UI界面進行,但是就少了一些韻味,還是使用原生的CLI工具最能體現(xiàn)程序執(zhí)行的過程,并且真是的生產(chǎn)環(huán)境中大多數(shù)也只能通過這種命令的方式來進行,因此我們就有必要搞一下這個大蟒蛇工具——Cobra。
1 簡介
GitHub:https://github.com/spf13/cobra
Cobra是一個用于創(chuàng)建強大的現(xiàn)代CLI應(yīng)用程序的庫。在很多圍棋項目中使用,比如Kubernetes, Hugo和GitHub CLI等等。
那么什么是CLI呢,簡單來講就是命令行工具界面,Command Line Interface for batch scripting的簡稱,在我們開發(fā)中廣泛的使用,比如你打開Git Bash,輸入git clone XXX,這個就是操作Git的命令行工具界面。
除此之外,Cobra還提供:
- 簡單的基于子命令的cli:應(yīng)用服務(wù)器,應(yīng)用獲取,等等。
- 完全兼容posix的標志(包括短版本和長版本)
- 嵌套的子命令
- 全局、本地和級聯(lián)標志
- 命令和標志的自動幫助生成
- 自動識別-h、——help等幫助標志。
- 為您的應(yīng)用程序自動生成shell自動完成(bash, zsh, fish, powershell)
- 為您的應(yīng)用程序自動生成的手冊頁
- 命令別名,以便您可以更改而不破壞它們
- 定義自己的幫助、用法等的靈活性。
什么是命令&參數(shù)&標識符?
Cobra 是構(gòu)建在命令、參數(shù)和標識符之上的:
Commands
表示執(zhí)行動作Args
就是執(zhí)行參數(shù)Flags
是這些動作的標識符
基本的執(zhí)行命令如下所示:
$ APPNAME Command Args --Flags # 或者 $ APPNAME Command --Flags Args
2 安裝
2.1 安裝Cobra-cli腳手架工具
go install github.com/spf13/cobra-cli@latest
下載完成之后會在我們的$GOPATH目錄的bin目錄下生成一個二進制的文件cobra-cli.exe(Windows下)或cobra-cli(LInux下),如果出現(xiàn)問題,如:
我們可以直接找到$GO_PATH\pkg\mod\github.com\spf13\cobra-cli@v1.3.0目錄,直接go build自己編譯一個二進制文件。
之后一步,為了方便使用我們可以將生成的二進制文件放在環(huán)境變量里,讓他在任何地方都能使用,步驟過于簡單就忽略了哈。
2.2 在項目中下載Cobra依賴
go get -u github.com/spf13/cobra@latest
3 使用方式
其實在使用方式這一塊有兩種方法,一種是自己直接寫代碼,另一種就是使用剛剛我們安裝的cobra-cli來生成腳手架代碼,我們就在Hello World里面將cobra-cli生成代碼試一遍。
3.1 Hello World
首先在項目根目錄下打開終端(必須是Go Module項目),然后輸入命令cobra-cli init
就會在項目中生成如下代碼:
我們看下具體的代碼:
main.go
package main import "go-cobra/cmd" func main() { cmd.Execute() }
root.go
package cmd import ( "os" "github.com/spf13/cobra" ) // rootCmd represents the base command when called without any subcommands var rootCmd = &cobra.Command{ Use: "go-cobra", Short: "A brief description of your application", Long: `A longer description that spans multiple lines and likely contains examples and usage of using your application. For example: Cobra is a CLI library for Go that empowers applications. This application is a tool to generate the needed files to quickly create a Cobra application.`, // Uncomment the following line if your bare application // has an action associated with it: // Run: func(cmd *cobra.Command, args []string) { }, } // Execute adds all child commands to the root command and sets flags appropriately. // This is called by main.main(). It only needs to happen once to the rootCmd. func Execute() { err := rootCmd.Execute() if err != nil { os.Exit(1) } } func init() { // Here you will define your flags and configuration settings. // Cobra supports persistent flags, which, if defined here, // will be global for your application. // rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.go-cobra.yaml)") // Cobra also supports local flags, which will only run // when this action is called directly. rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle") }
我們將root.go里面的代碼進行部分修改:
package cmd import ( "fmt" "github.com/spf13/cobra" "os" ) var name string var rootCmd = &cobra.Command{ Use: "hello", Run: func(cmd *cobra.Command, args []string) { fmt.Println("hello ", name) }, } func Execute() { err := rootCmd.Execute() if err != nil { os.Exit(1) } } func init() { rootCmd.Flags().StringVarP(&name, "name", "", "world", "") }
測試:
$ go build $ .\go-cobra.exe --name zs hello zs $ .\go-cobra.exe hello world
3.2 開發(fā)自己的Cli命令
使用cobra-cli腳手架,或者也可以自己手寫如下代碼
cobra-cli add hi
這個時候我們就會發(fā)現(xiàn)多了一個文件,當然也可以自己手寫代碼:
在hi.go文件中代碼:
package cmd import ( "fmt" "github.com/spf13/cobra" ) var ( age int like []string address string ) var hiCmd = &cobra.Command{ Use: "hi", Short: "", Long: "", Run: func(cmd *cobra.Command, args []string) { Print() }, } func init() { rootCmd.AddCommand(hiCmd) hiCmd.Flags().StringVarP(&name, "name", "", "world", "") hiCmd.Flags().IntVarP(&age, "age", "", 1, "") hiCmd.Flags().StringSliceVarP(&like, "like", "", []string{}, "") hiCmd.Flags().StringVarP(&address, "address", "", "Beijing", "") } func Print() { fmt.Println("name:", name) fmt.Println("age:", age) fmt.Println("like:", like) fmt.Println("address:", address) }
測試:
.\go-cobra.exe hi --name zs --age 100 --like Coding,Running --address ShangHai
name: zs
age: 100
like: [Coding Running]
address: ShangHai
3.3 規(guī)則和擴展使用
3.3.1 我們不難看出規(guī)則
新增命令就是自定義&cobra.Command
新增標識符就是命令.Flags().xxx
新增的命令都需要在rootCmd中添加,新增的標識符都要在init中添加
3.3.2 小擴展
一些常用到的方法:
- NoArgs:如果有任何參數(shù),命令行將會報錯
- ArbitraryArgs: 命令行將會接收任何參數(shù)
- OnlyValidArgs: 如果有如何參數(shù)不屬于 Command 的 ValidArgs 字段,命令行將會報錯
- MinimumNArgs(int): 如果參數(shù)個數(shù)少于 N 個,命令行將會報錯
- MaximumNArgs(int): 如果參數(shù)個數(shù)多于 N 個,命令行將會報錯
- ExactArgs(int): 如果參數(shù)個數(shù)不等于 N 個,命令行將會報錯
- RangeArgs(min, max): 如果參數(shù)個數(shù)不在 min 和 max 之間, 命令行將會報錯
3.3.3 自定義幫助命令
... var hiCmd = &cobra.Command{ Use: "hi", Short: "sss", Long: "lll", Run: func(cmd *cobra.Command, args []string) { if len(args) == 0 { cmd.Help() return } Print() }, } ...
測試:
$ .\go-cobra.exe hi Usage: hello hi [flags] Usage: hello hi [flags] Flags: --address string (default "Beijing") --age int (default 1) -h, --help help for hi --like strings --name string (default "world")
4 小總結(jié)
本文介紹了Cobra的最基本也是最常用的使用部分,但是Cobra仍然有很多優(yōu)秀的操作值得我們學習。拜拜嘍~
到此這篇關(guān)于玩轉(zhuǎn)Go命令行工具Cobra的文章就介紹到這了,更多相關(guān)Go命令行工具Cobra內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Golang應(yīng)用執(zhí)行Shell命令實戰(zhàn)
本文主要介紹了Golang應(yīng)用執(zhí)行Shell命令實戰(zhàn),文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2023-03-03golang常用加密解密算法總結(jié)(AES、DES、RSA、Sha1、MD5)
在項目開發(fā)過程中,當操作一些用戶的隱私信息,本文主要主要介紹了golang常用加密解密算法總結(jié)(AES、DES、RSA、Sha1MD5),文中通過示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下2022-04-04解決Goland中利用HTTPClient發(fā)送請求超時返回EOF錯誤DEBUG
這篇文章主要介紹了解決Goland中利用HTTPClient發(fā)送請求超時返回EOF錯誤DEBUG,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12