Go語言命令行利器cobra使用教程

cobra是一個提供簡單接口來創(chuàng)建強大的現(xiàn)代CLI界面的庫類似git git tools，cobra也是一個應(yīng)用程序，它會生成你的應(yīng)用程序的腳手架來快速開發(fā)基于cobra的應(yīng)用程序

成都創(chuàng)新互聯(lián)公司，專注為中小企業(yè)提供官網(wǎng)建設(shè)、營銷型網(wǎng)站制作、響應(yīng)式網(wǎng)站設(shè)計、展示型做網(wǎng)站、成都網(wǎng)站制作等服務(wù)，幫助中小企業(yè)通過網(wǎng)站體現(xiàn)價值、有效益。幫助企業(yè)快速建站、解決網(wǎng)站建設(shè)與網(wǎng)站營銷推廣問題。

cobra提供：

cobra建立在命令、參數(shù)、標志的結(jié)構(gòu)之上

commands代表動作，args是事物，flags是動作的修飾符

最好的應(yīng)用程序在使用時讀起來就像句子，因此，用戶直觀地知道如何與它們交互

模式如下：APPNAME VERB NOUN --ADJECTIVE. or APPNAME COMMAND ARG --FLAG（APPNAME 動詞 名詞 形容詞 或者 APPNAME 命令 參數(shù) 標志）

一些真實世界的好例子可以更好地說明這一點

kubectl 命令更能體現(xiàn)APPNAME 動詞 名詞 形容詞

如下的例子，server 是command，port是flag

這個命令中，我們告訴git 克隆url

命令是應(yīng)用程序的中心點，應(yīng)用程序支持的每一個交互都包含在一個命令中，命令可以有子命令，也可以運行操作

在上面的例子中，server是命令

更多關(guān)于cobra.Command

flag是一種修改命令行為的方式，cobra支持完全兼容POSIX標志，也支持go flag package，cobra可以定義到子命令上的標志，也可以僅對該命令可用的標志

在上面的命令中，port是標志

標志的功能由 pflag library 提供，pflag library是flag標準庫的一個分支，在添加POSIX兼容性的同時維護相同的接口。

使用cobra很簡單，首先，使用go get按照最新版本的庫，這個命令會安裝cobra可執(zhí)行程序以及庫和依賴項

下一步，引入cobra到應(yīng)用程序中

雖然歡迎您提供自己的組織，但通常基于Cobra的應(yīng)用程序?qū)⒆裱韵陆M織結(jié)構(gòu)：

在Cobra應(yīng)用程序中，main.go文件通常非常簡單。它有一個目的：初始化Cobra。

使用cobra生成器

cobra提供了程序用來創(chuàng)建你的應(yīng)用程序然后添加你想添加的命令，這是將cobra引入應(yīng)用程序最簡單的方式

這兒 你可以發(fā)現(xiàn)關(guān)于cobra的更多信息

要手動實現(xiàn)cobra，需要創(chuàng)建一個main.go 和rootCmd文件，可以根據(jù)需要提供其他命令

Cobra不需要任何特殊的構(gòu)造器。只需創(chuàng)建命令。

理想情況下，您可以將其放在app/cmd/root.go中：

在init（）函數(shù)中定義標志和處理配置

例子如下，cmd/root.go:

創(chuàng)建main.go

使用root命令，您需要讓主函數(shù)執(zhí)行它。為清楚起見，Execute應(yīng)該在根目錄下運行，盡管它可以在任何命令上調(diào)用。

在Cobra應(yīng)用程序中，main.go文件通常非常簡單。它有一個目的：初始化Cobra。

可以定義其他命令，通常每個命令在cmd/目錄中都有自己的文件。

如果要創(chuàng)建版本命令，可以創(chuàng)建cmd/version.go并用以下內(nèi)容填充它：

如果希望將錯誤返回給命令的調(diào)用者，可以使用RunE。

然后可以在execute函數(shù)調(diào)用中捕獲錯誤。

標志提供修飾符來控制操作命令的操作方式。

由于標志是在不同的位置定義和使用的，因此我們需要在外部定義一個具有正確作用域的變量來分配要使用的標志。

有兩種不同的方法來分配標志。

標志可以是“持久”的，這意味著該標志將可用于分配給它的命令以及該命令下的每個命令。對于全局標志，在根上指定一個標志作為持久標志。

也可以在本地分配一個標志，該標志只應(yīng)用于該特定命令。

默認情況下，Cobra只解析目標命令上的本地標志，而忽略父命令上的任何本地標志。通過啟用Command.TraverseChildren，Cobra將在執(zhí)行目標命令之前解析每個命令上的本地標志。

使用viper綁定標志

在本例中，持久標志author與viper綁定。注意：當用戶未提供--author標志時，變量author將不會設(shè)置為config中的值。

更多關(guān)于 viper的文檔

Flags默認是可選的，如果希望命令在未設(shè)置標志時報告錯誤，請根據(jù)需要進行標記：

持久性Flags

可以使用命令的Args字段指定位置參數(shù)的驗證。

內(nèi)置了以下驗證器：

在下面的示例中，我們定義了三個命令。兩個是頂級命令，一個（cmdTimes）是頂級命令之一的子命令。在這種情況下，根是不可執(zhí)行的，這意味著需要一個子命令。這是通過不為“rootCmd”提供“Run”來實現(xiàn)的。

我們只為一個命令定義了一個標志。

有關(guān)標志的更多文檔，請訪問

對于一個更完整的例子更大的應(yīng)用程序，請檢查 Hugo 。

當您有子命令時，Cobra會自動將help命令添加到應(yīng)用程序中。當用戶運行“應(yīng)用程序幫助”時，將調(diào)用此函數(shù)。此外，help還支持所有其他命令作為輸入。例如，您有一個名為“create”的命令，沒有任何附加配置；調(diào)用“app help create”時，Cobra將起作用。每個命令都會自動添加“-help”標志。

以下輸出由Cobra自動生成。除了命令和標志定義之外，不需要任何東西。

幫助就像其他命令一樣。它周圍沒有特殊的邏輯或行為。事實上，你可以提供你想提供的。

您可以為默認命令提供自己的幫助命令或模板，以用于以下功能：

當用戶提供無效的標志或無效的命令時，Cobra通過向用戶顯示“用法”來響應(yīng)。

你可以從上面的幫助中認識到這一點。這是因為默認幫助將用法作為其輸出的一部分嵌入。

您可以提供自己的使用函數(shù)或模板供Cobra使用。與幫助一樣，函數(shù)和模板也可以通過公共方法重寫：

如果在root命令上設(shè)置了version字段，Cobra會添加一個頂級的'--version'標志。運行帶有“-version”標志的應(yīng)用程序?qū)⑹褂冒姹灸０鍖姹敬蛴〉綐藴瘦敵觥？梢允褂胏md.SetVersionTemplate（s string）函數(shù)自定義模板。

可以在命令的主運行函數(shù)之前或之后運行函數(shù)。PersistentPreRun和PreRun函數(shù)將在運行之前執(zhí)行。PersistentPostRun和PostRun將在運行后執(zhí)行。如果子函數(shù)不聲明自己的函數(shù)，則它們將繼承Persistent*Run函數(shù)。這些函數(shù)按以下順序運行：

輸出：

當發(fā)生“未知命令”錯誤時，Cobra將打印自動建議。這使得Cobra在發(fā)生拼寫錯誤時的行為類似于git命令。例如：

基于注冊的每個子命令和Levenshtein距離的實現(xiàn)，建議是自動的。匹配最小距離2（忽略大小寫）的每個已注冊命令都將顯示為建議。

如果需要在命令中禁用建議或調(diào)整字符串距離，請使用：

or

您還可以使用SuggestFor屬性顯式設(shè)置將為其建議給定命令的名稱。這允許對在字符串距離方面不接近的字符串提供建議，但在您的一組命令中是有意義的，并且對于某些您不需要別名的字符串。例子：

Cobra可以基于子命令、標志等生成文檔。請在 docs generation文檔 中閱讀更多關(guān)于它的信息。

Cobra可以為以下shell生成shell完成文件：bash、zsh、fish、PowerShell。如果您在命令中添加更多信息，這些補全功能將非常強大和靈活。在 Shell Completions 中閱讀更多關(guān)于它的信息。

Cobra is released under the Apache 2.0 license. See LICENSE.txt

GO語言商業(yè)案例（十八）：stream

切換到新語言始終是一大步，尤其是當您的團隊成員只有一個時有該語言的先前經(jīng)驗。現(xiàn)在，Stream 的主要編程語言從 Python 切換到了 Go。這篇文章將解釋stream決定放棄 Python 并轉(zhuǎn)向 Go 的一些原因。

Go 非常快。性能類似于 Java 或 C++。對于用例，Go 通常比 Python 快 40 倍。

對于許多應(yīng)用程序來說，編程語言只是應(yīng)用程序和數(shù)據(jù)庫之間的粘合劑。語言本身的性能通常并不重要。然而，Stream 是一個API 提供商，為 700 家公司和超過 5 億最終用戶提供提要和聊天平臺。多年來，我們一直在優(yōu)化 Cassandra、PostgreSQL、Redis 等，但最終，您會達到所使用語言的極限。Python 是一門很棒的語言，但對于序列化/反序列化、排名和聚合等用例，它的性能相當緩慢。我們經(jīng)常遇到性能問題，Cassandra 需要 1 毫秒來檢索數(shù)據(jù)，而 Python 會花費接下來的 10 毫秒將其轉(zhuǎn)換為對象。

看看我如何開始 Go 教程中的一小段 Go 代碼。（這是一個很棒的教程，也是學(xué)習 Go 的一個很好的起點。）

如果您是 Go 新手，那么在閱讀那個小代碼片段時不會有太多讓您感到驚訝的事情。它展示了多個賦值、數(shù)據(jù)結(jié)構(gòu)、指針、格式和一個內(nèi)置的 HTTP 庫。當我第一次開始編程時，我一直喜歡使用 Python 更高級的功能。Python 允許您在編寫代碼時獲得相當?shù)膭?chuàng)意。例如，您可以：

這些功能玩起來很有趣，但是，正如大多數(shù)程序員會同意的那樣，在閱讀別人的作品時，它們通常會使代碼更難理解。Go 迫使你堅持基礎(chǔ)。這使得閱讀任何人的代碼并立即了解發(fā)生了什么變得非常容易。 注意：當然，它實際上有多“容易”取決于您的用例。如果你想創(chuàng)建一個基本的 CRUD API，我仍然推薦 Django + DRF或 Rails。

作為一門語言，Go 試圖讓事情變得簡單。它沒有引入許多新概念。重點是創(chuàng)建一種非常快速且易于使用的簡單語言。它唯一具有創(chuàng)新性的領(lǐng)域是 goroutine 和通道。（100% 正確CSP的概念始于 1977 年，所以這項創(chuàng)新更多是對舊思想的一種新方法。）Goroutines 是 Go 的輕量級線程方法，通道是 goroutines 之間通信的首選方式。Goroutines 的創(chuàng)建非常便宜，并且只需要幾 KB 的額外內(nèi)存。因為 Goroutine 非常輕量，所以有可能同時運行數(shù)百甚至數(shù)千個。您可以使用通道在 goroutine 之間進行通信。Go 運行時處理所有復(fù)雜性。goroutines 和基于通道的并發(fā)方法使得使用所有可用的 CPU 內(nèi)核和處理并發(fā) IO 變得非常容易——所有這些都不會使開發(fā)復(fù)雜化。與 Python/Java 相比，在 goroutine 上運行函數(shù)需要最少的樣板代碼。您只需在函數(shù)調(diào)用前加上關(guān)鍵字“go”：

Go 的并發(fā)方法很容易使用。與 Node 相比，這是一種有趣的方法，開發(fā)人員必須密切關(guān)注異步代碼的處理方式。Go 中并發(fā)的另一個重要方面是競爭檢測器。這樣可以很容易地確定異步代碼中是否存在任何競爭條件。

我們目前用 Go 編寫的最大的微服務(wù)編譯需要 4 秒。與以編譯速度慢而聞名的 Java 和 C++ 等語言相比，Go 的快速編譯時間是一項重大的生產(chǎn)力勝利。我喜歡在程序編譯的時候摸魚，但在我還記得代碼應(yīng)該做什么的同時完成事情會更好。

首先，讓我們從顯而易見的開始：與 C++ 和 Java 等舊語言相比，Go 開發(fā)人員的數(shù)量并不多。根據(jù)StackOverflow的數(shù)據(jù)， 38% 的開發(fā)人員知道 Java， 19.3% 的人知道 C++，只有 4.6% 的人知道 Go。GitHub 數(shù)據(jù)顯示了類似的趨勢：Go 比 Erlang、Scala 和 Elixir 等語言使用更廣泛，但不如 Java 和 C++ 流行。幸運的是，Go 是一種非常簡單易學(xué)的語言。它提供了您需要的基本功能，僅此而已。它引入的新概念是“延遲”聲明和內(nèi)置的并發(fā)管理與“goroutines”和通道。（對于純粹主義者來說：Go 并不是第一種實現(xiàn)這些概念的語言，只是第一種使它們流行起來的語言。）任何加入團隊的 Python、Elixir、C++、Scala 或 Java 開發(fā)人員都可以在一個月內(nèi)在 Go 上發(fā)揮作用，因為它的簡單性。與許多其他語言相比，我們發(fā)現(xiàn)組建 Go 開發(fā)人員團隊更容易。如果您在博爾德和阿姆斯特丹等競爭激烈的生態(tài)系統(tǒng)中招聘人員，這是一項重要的優(yōu)勢。

對于我們這樣規(guī)模的團隊（約 20 人）來說，生態(tài)系統(tǒng)很重要。如果您必須重新發(fā)明每一個小功能，您根本無法為您的客戶創(chuàng)造價值。Go 對我們使用的工具有很好的支持。實體庫已經(jīng)可用于 Redis、RabbitMQ、PostgreSQL、模板解析、任務(wù)調(diào)度、表達式解析和 RocksDB。與 Rust 或 Elixir 等其他較新的語言相比，Go 的生態(tài)系統(tǒng)是一個重大勝利。它當然不如 Java、Python 或 Node 之類的語言好，但它很可靠，而且對于許多基本需求，你會發(fā)現(xiàn)已經(jīng)有高質(zhì)量的包可用。

Gofmt 是一個很棒的命令行實用程序，內(nèi)置在 Go 編譯器中，用于格式化代碼。就功能而言，它與 Python 的 autopep8 非常相似。我們大多數(shù)人并不真正喜歡爭論制表符與空格。格式的一致性很重要，但實際的格式標準并不那么重要。Gofmt 通過使用一種正式的方式來格式化您的代碼來避免所有這些討論。

Go 對協(xié)議緩沖區(qū)和 gRPC 具有一流的支持。這兩個工具非常適合構(gòu)建需要通過 RPC 通信的微服務(wù)。您只需要編寫一個清單，在其中定義可以進行的 RPC 調(diào)用以及它們采用的參數(shù)。然后從這個清單中自動生成服務(wù)器和客戶端代碼。生成的代碼既快速又具有非常小的網(wǎng)絡(luò)占用空間并且易于使用。從同一個清單中，您甚至可以為許多不同的語言生成客戶端代碼，例如 C++、Java、Python 和 Ruby。因此，內(nèi)部流量不再有模棱兩可的 REST 端點，您每次都必須編寫幾乎相同的客戶端和服務(wù)器代碼。.

Go 沒有像 Rails 用于 Ruby、Django 用于 Python 或 Laravel 用于 PHP 那樣的單一主導(dǎo)框架。這是 Go 社區(qū)內(nèi)激烈爭論的話題，因為許多人主張你不應(yīng)該一開始就使用框架。我完全同意這對于某些用例是正確的。但是，如果有人想構(gòu)建一個簡單的 CRUD API，他們將更容易使用 Django/DJRF、Rails Laravel 或Phoenix。對于 Stream 的用例，我們更喜歡不使用框架。然而，對于許多希望提供簡單 CRUD API 的新項目來說，缺乏主導(dǎo)框架將是一個嚴重的劣勢。

Go 通過簡單地從函數(shù)返回錯誤并期望調(diào)用代碼來處理錯誤（或?qū)⑵浞祷氐秸{(diào)用堆棧）來處理錯誤。雖然這種方法有效，但很容易失去問題的范圍，以確保您可以向用戶提供有意義的錯誤。錯誤包通過允許您向錯誤添加上下文和堆棧跟蹤來解決此問題。另一個問題是很容易忘記處理錯誤。像 errcheck 和 megacheck 這樣的靜態(tài)分析工具可以方便地避免犯這些錯誤。雖然這些變通辦法效果很好，但感覺不太對勁。您希望該語言支持正確的錯誤處理。

Go 的包管理絕不是完美的。默認情況下，它無法指定特定版本的依賴項，也無法創(chuàng)建可重現(xiàn)的構(gòu)建。Python、Node 和 Ruby 都有更好的包管理系統(tǒng)。但是，使用正確的工具，Go 的包管理工作得很好。您可以使用Dep來管理您的依賴項，以允許指定和固定版本。除此之外，我們還貢獻了一個名為的開源工具VirtualGo，它可以更輕松地處理用 Go 編寫的多個項目。

我們進行的一個有趣的實驗是在 Python 中使用我們的排名提要功能并在 Go 中重寫它。看看這個排名方法的例子：

Python 和 Go 代碼都需要執(zhí)行以下操作來支持這種排名方法：

開發(fā) Python 版本的排名代碼大約花了 3 天時間。這包括編寫代碼、單元測試和文檔。接下來，我們花了大約 2 周的時間優(yōu)化代碼。其中一項優(yōu)化是將分數(shù)表達式 (simple_gauss(time)*popularity) 轉(zhuǎn)換為抽象語法樹. 我們還實現(xiàn)了緩存邏輯，可以在未來的特定時間預(yù)先計算分數(shù)。相比之下，開發(fā)此代碼的 Go 版本大約需要 4 天時間。性能不需要任何進一步的優(yōu)化。因此，雖然 Python 的最初開發(fā)速度更快，但基于 Go 的版本最終需要我們團隊的工作量大大減少。另外一個好處是，Go 代碼的執(zhí)行速度比我們高度優(yōu)化的 Python 代碼快大約 40 倍。現(xiàn)在，這只是我們通過切換到 Go 體驗到的性能提升的一個示例。

與 Python 相比，我們系統(tǒng)的其他一些組件在 Go 中構(gòu)建所需的時間要多得多。作為一個總體趨勢，我們看到 開發(fā) Go 代碼需要更多的努力。但是，我們花更少的時間 優(yōu)化 代碼以提高性能。

我們評估的另一種語言是Elixir.。Elixir 建立在 Erlang 虛擬機之上。這是一種迷人的語言，我們之所以考慮它，是因為我們的一名團隊成員在 Erlang 方面擁有豐富的經(jīng)驗。對于我們的用例，我們注意到 Go 的原始性能要好得多。Go 和 Elixir 都可以很好地服務(wù)數(shù)千個并發(fā)請求。但是，如果您查看單個請求的性能，Go 對于我們的用例來說要快得多。我們選擇 Go 而不是 Elixir 的另一個原因是生態(tài)系統(tǒng)。對于我們需要的組件，Go 有更成熟的庫，而在許多情況下，Elixir 庫還沒有準備好用于生產(chǎn)環(huán)境。培訓(xùn)/尋找開發(fā)人員使用 Elixir 也更加困難。這些原因使天平向 Go 傾斜。Elixir 的 Phoenix 框架看起來很棒，絕對值得一看。

Go 是一種非常高性能的語言，對并發(fā)有很好的支持。它幾乎與 C++ 和 Java 等語言一樣快。雖然與 Python 或 Ruby 相比，使用 Go 構(gòu)建東西確實需要更多時間，但您將節(jié)省大量用于優(yōu)化代碼的時間。我們在Stream有一個小型開發(fā)團隊，為超過 5 億最終用戶提供動力和聊天。Go 結(jié)合了 強大的生態(tài)系統(tǒng) 、新開發(fā)人員的 輕松入門、快速的性能 、對并發(fā)的 可靠支持和高效的編程環(huán)境 ，使其成為一個不錯的選擇。Stream 仍然在我們的儀表板、站點和機器學(xué)習中利用 Python 來提供個性化的訂閱源. 我們不會很快與 Python 說再見，但今后所有性能密集型代碼都將使用 Go 編寫。我們新的聊天 API也完全用 Go 編寫。

go語言命令行打印清除

命令如下：

直接在終端中輸入gohelp即可顯示所有的go命令以及相應(yīng)命令功能簡介，主要有下面這些:

build:編譯包和依賴；clean:移除對象文件；doc:顯示包或者符號的文檔；env:打印go的環(huán)境信息；bug:啟動錯誤報告；fix:運行g(shù)otoolfix；fmt:運行g(shù)ofmt進行格式化；generate:從processingsource生成go文件

get:下載并安裝包和依賴；install:編譯并安裝包和依賴；list:列出包；run:編譯并運行g(shù)o程序；test:運行測試；tool:運行g(shù)o提供的工具；version:顯示go的版本；vet:運行g(shù)otoolvet；命令的使用方式為:gocommand[args],除此之外，可以使用gohelp；來顯示指定命令的更多幫助信息。；在運行g(shù)ohelp時，不僅僅打印了這些命令的基本信息，還給出了一些概念的幫助信息:；c:Go和c的相互調(diào)用；buildmode:構(gòu)建模式的描述；filetype:文件類型；gopath:GOPATH環(huán)境變量

environment:環(huán)境變量；importpath:導(dǎo)入路徑語法；packages:包列表的描述；testflag:測試符號描述；testfunc:測試函數(shù)描述等。

寫命令行應(yīng)用程序什么不可或缺？Go可以這樣處理命令行參數(shù)

Go語言內(nèi)置的flag包實現(xiàn)了命令行參數(shù)的解析，flag包使得開發(fā)命令行工具更為簡單。

如果你只是簡單的想要獲取命令行參數(shù)，可以像下面的代碼示例一樣使用os.Args來獲取命令行參數(shù)。

將上面的代碼執(zhí)行g(shù)o build -o "args_demo"編譯之后，執(zhí)行：

os.Args是一個存儲命令行參數(shù)的字符串切片，它的第一個元素是執(zhí)行文件的名稱。

本文介紹了flag包的常用函數(shù)和基本用法，更詳細的內(nèi)容請查看官方文檔。

flag包支持的命令行參數(shù)類型有bool、int、int64、uint、uint64、float float64、string、duration。

有以下兩種常用的定義命令行flag參數(shù)的方法。

基本格式如下：

flag.Type(flag名, 默認值, 幫助信息)*Type 例如我們要定義姓名、年齡、婚否三個命令行參數(shù)，我們可以按如下方式定義：

需要注意的是，此時name、age、married、delay均為對應(yīng)類型的指針。

基本格式如下： flag.TypeVar(Type指針, flag名, 默認值, 幫助信息) 例如我們要定義姓名、年齡、婚否三個命令行參數(shù)，我們可以按如下方式定義：

通過以上兩種方法定義好命令行flag參數(shù)后，需要通過調(diào)用flag.Parse()來對命令行參數(shù)進行解析。

支持的命令行參數(shù)格式有以下幾種：

其中，布爾類型的參數(shù)必須使用等號的方式指定。

Flag解析在第一個非flag參數(shù)（單個”-“不是flag參數(shù)）之前停止，或者在終止符”–“之后停止。

定義

使用

命令行參數(shù)使用提示：

$ ./flag_demo -help

Usage of ./flag_demo:

-age int

年齡 (default 18)

-d duration

時間間隔

-married

婚否

-name string

姓名 (default "張三")

正常使用命令行flag參數(shù)：

使用非flag命令行參數(shù)：

原文鏈接：

golang命令行庫Cobra的使用

寫了2次才寫完，內(nèi)容很長，翻譯了很久，內(nèi)容來源于Cobra github介紹。翻譯完也更全面的了解了Cobra，功能相當強大完善，各種使用的場景都考慮到了。另外也擴展了一些其它知識，比如 命令行玩法 ， Levenshtein distance 等等。以下是正文：

Cobra提供簡單的接口來創(chuàng)建強大的現(xiàn)代化CLI接口，比如git與go工具。Cobra同時也是一個程序, 用于創(chuàng)建CLI程序

Cobra是建立在結(jié)構(gòu)的命令、參數(shù)和標志之上。

命令代表操作,參數(shù)和標志是這些行動的修飾符。

最好的應(yīng)用程序就像讀取句子。用戶會知道如何使用本機應(yīng)用程序，因為他們將理解如何使用它。

比如下面的例子， server 是命令， port 是標志:

在下面的命令，我們告訴Git克隆url地址bare

使用Cobra很簡單。首先，使用 go get 安裝最新版本

然后在你項目里引用Cobra

通常基于Cobra的應(yīng)用程序?qū)⒆裱旅娴慕M織結(jié)構(gòu)，當然你也可以遵循自己的接口：

在Cobra應(yīng)用程序中，通常main.go文件非常空洞。它主要只干一件事：初始化Cobra。

Cobra提供自己的程序來創(chuàng)建你的程序并且添加你想要的命令。這是最簡單的方式把Cobra添加到你的程序里。

這里 你能找到相關(guān)信息

使用Cobra，需要創(chuàng)建一個空的main.go文件和一個rootCmd文件。你可以選擇在合適的地方添加額外的命令。

Cobra不需要特殊的構(gòu)造函數(shù)。簡單的就可以創(chuàng)建你的命令。

理想情況下你把這個放在在 app/cmd/root.go

你會另外定義標志和處理配置init()函數(shù)。

比如 cmd/root.go

你需要在main函數(shù)里執(zhí)行root命令。

通常main.go文件非常空洞。它主要只干一件事：初始化Cobra。

其它的命令通常定義在cmd/目錄下的自己文件內(nèi)

如果你想創(chuàng)建一個version命令，你可以創(chuàng)建cmd/version.go文件，并在文件里這么寫:

標志提供修飾符控制動作命令如何操作

當標志定義好了，我們需要定義一個變量來關(guān)聯(lián)標志

'持久'表示每個在那個命令下的命令都將能分配到這個標志。對于全局標志，'持久'的標志綁定在root上。

Cobra默認只在目標命令上解析標志，父命令忽略任何局部標志。通過打開 Command.TraverseChildren Cobra將會在執(zhí)行任意目標命令前解析標志

你同樣可以通過 viper 綁定標志：

在這個例子中，永久的標記 author 被 viper 綁定, 注意 , 當用戶沒有給 --author 提供值， author 不會被賦值。

標記默認是可選的，如果你希望當一個標記沒有設(shè)置時，命令行報錯，你可以標記它為必須的

驗證位置參數(shù)可以通過 Command 的 Args 字段。

內(nèi)置下列驗證方法

一個設(shè)置自定義驗證的例子

在下面的例子，我們定義了3個命令。2個在頂級，一個（cmdTimes）是其中一個頂級命令的子命令。在這個例子里，由于沒有給 rootCmd 提供 Run ，單獨的root是不能運行的，必須要有子命令。

我們僅為一個命令定義了標記。

更多關(guān)于flags的文檔可以在 找到

更完整大型程序的例子, 可以查看 Hugo .

當你的程序有子命令時，Cobra 會自動給你程序添加help命令。當你運行‘a(chǎn)pp help’，會調(diào)用help命令。另外，help同樣支持其它輸入命令。例如，你有一個沒有任何其它配置的命令叫‘create’，當你調(diào)用‘a(chǎn)pp help create’ Corbra 將會起作用。

下面的輸入是 Cobra 自動生成的。除了命令和標志的定義，其它不再需要。

help 就跟其它命令一樣，并沒有特殊的邏輯或行為。事實上，你也可以提供你自己help如果你想的話。

你能為默認的命令，提供你自己的help命令或模板。使用下面的方法:

后2個也將適用于任何子命令

當用戶提供無效的標記或命令，Cobra 將會返回 用法 。

你可能從上面的幫助意識到，默認的幫助將被嵌入到用法里然后作為輸出。

你能提供你自己的用法函數(shù)或模板給 Cobra 使用。

比如幫助，方法和模板都可以重寫。

如果Version字段設(shè)置到了根命令，Cobra 會提供了一個頂層 ‘--version’標記。運行帶上‘--version’標記的程序，將會按照模板版本信息。模板可以通過 cmd.SetVersionTemplate(s string) 方法修改

在命令運行前或運行后，再運行方法非常容易。 PersistentPreRun 和 PreRun 方法將會在 Run 之前執(zhí)行。 PersistentPostRun 和 PostRun 方法將會在 Run 之后執(zhí)行。 Persistent*Run 方法會被子命令繼承，如果它們自己沒有定義的話。這些方法將按照下面的屬性執(zhí)行：

下面的例子，2個命令都使用了上面的特性。當子命令執(zhí)行的時候，它將執(zhí)行根命令的 PersistentPreRun ，但不會執(zhí)行根命令的 PersistentPostRun ：

輸出:

Cobra 會自動輸出建議，當遇到“unknown command”錯誤時。這使得當輸入錯誤時， Cobra 的行為類似 git 命令。例如：

建議會基于注冊的子命令自動生成。使用了 Levenshtein distance 的實現(xiàn)。每一個注冊的命令會匹配2個距離（忽略大小寫）來提供建議。

如果你希望在你的命令里，禁用建議或虛弱字符串的距離，使用：

或

你可以通過 SuggestFor 來給命令提供明確的名詞建議。這個特性允許當字符串不相近，但是意思與你的命令相近，別切你也不想給該命令設(shè)置別名。比如：

Cobra 可以基于子命令，標記，等生成文檔。以以下格式：

Cobra 可以生成一個bash-completion文件。如果你給命令添加更多信息，這些completions可以非常強大和靈活。更多介紹在 Bash Completions 。

分享標題：go語言命令行程序,怎么運行GO語言的可執(zhí)行文件
網(wǎng)頁路徑：http://chinadenli.net/article25/dsgdpji.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供定制網(wǎng)站、外貿(mào)網(wǎng)站建設(shè)、、域名注冊、網(wǎng)站改版、App開發(fā)

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請盡快告知，我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場，如需處理請聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時需注明來源： 創(chuàng)新互聯(lián)