golang命令行庫Cobra的使用

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

創(chuàng)新互聯(lián)是一家集網(wǎng)站建設,特克斯企業(yè)網(wǎng)站建設,特克斯品牌網(wǎng)站建設,網(wǎng)站定制,特克斯網(wǎng)站建設報價,網(wǎng)絡營銷,網(wǎng)絡優(yōu)化,特克斯網(wǎng)站推廣為一體的創(chuàng)新建站企業(yè)，幫助傳統(tǒng)企業(yè)提升企業(yè)形象加強企業(yè)競爭力。可充分滿足這一群體相比中小企業(yè)更為豐富、高端、多元的互聯(lián)網(wǎng)需求。同時我們時刻保持專業(yè)、時尚、前沿，時刻以成就客戶成長自我，堅持不斷學習、思考、沉淀、凈化自己，讓我們?yōu)楦嗟钠髽I(yè)打造出實用型網(wǎng)站。

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

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

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

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

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

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

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

然后在你項目里引用Cobra

通常基于Cobra的應用程序將遵循下面的組織結構，當然你也可以遵循自己的接口：

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

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

這里 你能找到相關信息

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

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

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

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

比如 cmd/root.go

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

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

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

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

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

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

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

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

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

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

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

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

內置下列驗證方法

一個設置自定義驗證的例子

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

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

更多關于flags的文檔可以在 找到

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

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

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

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

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

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

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

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

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

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

如果Version字段設置到了根命令，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 來給命令提供明確的名詞建議。這個特性允許當字符串不相近，但是意思與你的命令相近，別切你也不想給該命令設置別名。比如：

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

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

Go執(zhí)行命令行操作

go中提供了 os/exec 包使用 Command 函數(shù)可以完成一些調用命令行的操作。因為系統(tǒng)的不同，調用的參數(shù)會有點些不一樣。

其他的創(chuàng)建執(zhí)行都是一樣的。

我們可以封裝一個函數(shù)，輸入需要執(zhí)行的命令，輸入返回結果

調用測試

GO語言（十一）：開始使用多模塊工作區(qū)

本教程介紹 Go 中多模塊工作區(qū)的基礎知識。使用多模塊工作區(qū)，您可以告訴 Go 命令您正在同時在多個模塊中編寫代碼，并輕松地在這些模塊中構建和運行代碼。

在本教程中，您將在共享的多模塊工作區(qū)中創(chuàng)建兩個模塊，對這些模塊進行更改，并在構建中查看這些更改的結果。

本教程需要 go1.18 或更高版本。使用go.dev/dl中的鏈接確保您已在 Go 1.18 或更高版本中安裝了 Go 。

首先，為您要編寫的代碼創(chuàng)建一個模塊。

1、打開命令提示符并切換到您的主目錄。

在 Linux 或 Mac 上：

在 Windows 上：

2、在命令提示符下，為您的代碼創(chuàng)建一個名為工作區(qū)的目錄。

3、初始化模塊

我們的示例將創(chuàng)建一個hello依賴于 golang.org/x/example 模塊的新模塊。

創(chuàng)建你好模塊：

使用 . 添加對 golang.org/x/example 模塊的依賴項go get。

在 hello 目錄下創(chuàng)建 hello.go，內容如下：

現(xiàn)在，運行 hello 程序：

在這一步中，我們將創(chuàng)建一個go.work文件來指定模塊的工作區(qū)。

在workspace目錄中，運行：

該go work init命令告訴為包含目錄中模塊的工作空間go創(chuàng)建一個文件 。go.work./hello

該go命令生成一個go.work如下所示的文件：

該go.work文件的語法與go.mod相同。

該go指令告訴 Go 應該使用哪個版本的 Go 來解釋文件。它類似于文件中的go指令go.mod 。

該use指令告訴 Go在進行構建時hello目錄中的模塊應該是主模塊。

所以在模塊的任何子目錄中workspace都會被激活。

2、運行工作區(qū)目錄下的程序

在workspace目錄中，運行：

Go 命令包括工作區(qū)中的所有模塊作為主模塊。這允許我們在模塊中引用一個包，即使在模塊之外。在模塊或工作區(qū)之外運行go run命令會導致錯誤，因為該go命令不知道要使用哪些模塊。

接下來，我們將golang.org/x/example模塊的本地副本添加到工作區(qū)。然后，我們將向stringutil包中添加一個新函數(shù)，我們可以使用它來代替Reverse.

在這一步中，我們將下載包含該模塊的 Git 存儲庫的副本golang.org/x/example，將其添加到工作區(qū)，然后向其中添加一個我們將從 hello 程序中使用的新函數(shù)。

1、克隆存儲庫

在工作區(qū)目錄中，運行git命令來克隆存儲庫：

2、將模塊添加到工作區(qū)

該go work use命令將一個新模塊添加到 go.work 文件中。它現(xiàn)在看起來像這樣：

該模塊現(xiàn)在包括example.com/hello模塊和 `golang.org/x/example 模塊。

這將允許我們使用我們將在模塊副本中編寫的新代碼，而不是使用命令stringutil下載的模塊緩存中的模塊版本。

3、添加新功能。

我們將向golang.org/x/example/stringutil包中添加一個新函數(shù)以將字符串大寫。

將新文件夾添加到workspace/example/stringutil包含以下內容的目錄：

4、修改hello程序以使用該功能。

修改workspace/hello/hello.go的內容以包含以下內容：

從工作區(qū)目錄，運行

Go 命令在go.work文件指定的hello目錄中查找命令行中指定的example.com/hello模塊 ，同樣使用go.work文件解析導入golang.org/x/example。

go.work可以用來代替添加replace 指令以跨多個模塊工作。

由于這兩個模塊在同一個工作區(qū)中，因此很容易在一個模塊中進行更改并在另一個模塊中使用它。

現(xiàn)在，要正確發(fā)布這些模塊，我們需要發(fā)布golang.org/x/example 模塊，例如在v0.1.0. 這通常通過在模塊的版本控制存儲庫上標記提交來完成。發(fā)布完成后，我們可以增加對 golang.org/x/example模塊的要求hello/go.mod：

這樣，該go命令可以正確解析工作區(qū)之外的模塊。

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

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

cobra提供：

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

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

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

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

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

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

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

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

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

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

更多關于cobra.Command

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

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

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

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

下一步，引入cobra到應用程序中

雖然歡迎您提供自己的組織，但通常基于Cobra的應用程序將遵循以下組織結構：

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

使用cobra生成器

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

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

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

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

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

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

例子如下，cmd/root.go:

創(chuàng)建main.go

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

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

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

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

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

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

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

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

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

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

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

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

使用viper綁定標志

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

更多關于 viper的文檔

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

持久性Flags

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

內置了以下驗證器：

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

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

有關標志的更多文檔，請訪問

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

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

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

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

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

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

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

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

如果在root命令上設置了version字段，Cobra會添加一個頂級的'--version'標志。運行帶有“-version”標志的應用程序將使用版本模板將版本打印到標準輸出。可以使用cmd.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（忽略大小寫）的每個已注冊命令都將顯示為建議。

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

or

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

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

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

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

如何使用Go語言實現(xiàn)遠程執(zhí)行命令

一般命令

所謂一般命令，就是在一定時間內會執(zhí)行完的命令。比如 grep, cat 等等。 執(zhí)行命令的步驟是：連接，執(zhí)行，獲取結果

連接

連接包含了認證，可以使用 password 或者 sshkey 2種方式來認證。下面的示例為了簡單，使用了密碼認證的方式來完成連接。

import (

"fmt"

"time"

"golang.org/x/crypto/ssh"

)

func connect(user, password, host string, port int) (*ssh.Session, error) {

var (

auth []ssh.AuthMethod

addr string

clientConfig *ssh.ClientConfig

client *ssh.Client

session *ssh.Session

err error

)

// get auth method

auth = make([]ssh.AuthMethod, 0)

auth = append(auth, ssh.Password(password))

clientConfig = ssh.ClientConfig{

User: user,

Auth: auth,

Timeout: 30 * time.Second,

}

// connet to ssh

addr = fmt.Sprintf("%s:%d", host, port)

if client, err = ssh.Dial("tcp", addr, clientConfig); err != nil {

return nil, err

}

// create session

if session, err = client.NewSession(); err != nil {

return nil, err

}

return session, nil

}

連接的方法很簡單，只要提供登錄主機的 用戶*， *密碼*， *主機名或者IP*， *SSH端口

執(zhí)行，命令獲取結果

連接成功后，執(zhí)行命令很簡單

import (

"fmt"

"log"

"os"

"time"

"golang.org/x/crypto/ssh"

)

func main() {

session, err := connect("root", "xxxxx", "127.0.0.1", 22)

if err != nil {

log.Fatal(err)

}

defer session.Close()

session.Run("ls /; ls /abc")

}

上面代碼運行之后，雖然命令正常執(zhí)行了，但是沒有正常輸出的結果，也沒有異常輸出的結果。 要想顯示結果，需要將 session 的 Stdout 和 Stderr 重定向 修改 func main 為如下：

func main() {

session, err := connect("root", "xxxxx", "127.0.0.1", 22)

if err != nil {

log.Fatal(err)

}

defer session.Close()

session.Stdout = os.Stdout

session.Stderr = os.Stderr

session.Run("ls /; ls /abc")

}

這樣就能在屏幕上顯示正常，異常的信息了。

交互式命令

上面的方式無法遠程執(zhí)行交互式命令，比如 top ， 遠程編輯一個文件，比如 vi /etc/nginx/nginx.conf 如果要支持交互式的命令，需要當前的terminal來接管遠程的 PTY。

func main() {

session, err := connect("root", "olordjesus", "dockers.iotalabs.io", 2210)

if err != nil {

log.Fatal(err)

}

defer session.Close()

fd := int(os.Stdin.Fd())

oldState, err := terminal.MakeRaw(fd)

if err != nil {

panic(err)

}

defer terminal.Restore(fd, oldState)

// excute command

session.Stdout = os.Stdout

session.Stderr = os.Stderr

session.Stdin = os.Stdin

termWidth, termHeight, err := terminal.GetSize(fd)

if err != nil {

panic(err)

}

// Set up terminal modes

modes := ssh.TerminalModes{

ssh.ECHO: 1, // enable echoing

ssh.TTY_OP_ISPEED: 14400, // input speed = 14.4kbaud

ssh.TTY_OP_OSPEED: 14400, // output speed = 14.4kbaud

}

// Request pseudo terminal

if err := session.RequestPty("xterm-256color", termHeight, termWidth, modes); err != nil {

log.Fatal(err)

}

session.Run("top")

}

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

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

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

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

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

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

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

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

基本格式如下：

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

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

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

通過以上兩種方法定義好命令行flag參數(shù)后，需要通過調用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ù)：

原文鏈接：

新聞標題：go語言命令 go 常用命令
網(wǎng)頁路徑：http://www.chinadenli.net/article8/doojcop.html

成都網(wǎng)站建設公司_創(chuàng)新互聯(lián)，為您提供靜態(tài)網(wǎng)站、網(wǎng)站維護、ChatGPT、網(wǎng)站營銷、定制開發(fā)、外貿網(wǎng)站建設

廣告

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