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è),成都響應(yīng)式網(wǎng)站建設(shè)公司,商城建設(shè)。仁和網(wǎng)站建設(shè)公司,為仁和等地區(qū)提供建站服務(wù)。全流程按需求定制開發(fā)，專業(yè)設(shè)計，全程項目跟蹤，創(chuàng)新互聯(lián)建站專業(yè)和態(tài)度為您提供的服務(wù)

cobra提供：

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

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

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

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

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

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

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

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

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

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

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

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

在上面的命令中，port是標(biāo)志

標(biāo)志的功能由 pflag library 提供，pflag library是flag標(biāo)準(zhǔn)庫的一個分支，在添加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ù)中定義標(biāo)志和處理配置

例子如下，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)用中捕獲錯誤。

標(biāo)志提供修飾符來控制操作命令的操作方式。

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

有兩種不同的方法來分配標(biāo)志。

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

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

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

使用viper綁定標(biāo)志

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

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

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

持久性Flags

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

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

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

我們只為一個命令定義了一個標(biāo)志。

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

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

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

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

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

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

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

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

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

如果在root命令上設(shè)置了version字段，Cobra會添加一個頂級的'--version'標(biāo)志。運行帶有“-version”標(biāo)志的應(yīng)用程序?qū)⑹褂冒姹灸０鍖姹敬蛴〉綐?biāo)準(zhǔn)輸出。可以使用cmd.SetVersionTemplate（s string）函數(shù)自定義模板。

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

輸出：

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

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

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

or

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

Cobra可以基于子命令、標(biāo)志等生成文檔。請在 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語言實現(xiàn)遠(yuǎn)程執(zhí)行命令

一般命令

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

連接

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

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í)行，命令獲取結(jié)果

連接成功后，執(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í)行了，但是沒有正常輸出的結(jié)果，也沒有異常輸出的結(jié)果。 要想顯示結(jié)果，需要將 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")

}

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

交互式命令

上面的方式無法遠(yuǎn)程執(zhí)行交互式命令，比如 top ， 遠(yuǎn)程編輯一個文件，比如 vi /etc/nginx/nginx.conf 如果要支持交互式的命令，需要當(dāng)前的terminal來接管遠(yuǎn)程的 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")

}

總結(jié)

好了，這樣就可以執(zhí)行交互式命令了，比如上面的 top 也可以通過 vi /etc/nginx/nignx.conf 之類的命令來遠(yuǎn)程編輯文件。

可以用go語言成功執(zhí)行shutdown命令嗎？怎么做

import?(

"bytes"

"fmt"

"os/exec"

)

func?exec_shell()?(string,?error){

//函數(shù)返回一個*Cmd，用于使用給出的參數(shù)執(zhí)行name指定的程序

cmd?:=?exec.Command("shutdown",?"-h","now")

//讀取io.Writer類型的cmd.Stdout，再通過bytes.Buffer(緩沖byte類型的緩沖器)將byte類型轉(zhuǎn)化為string類型(out.String():這是bytes類型提供的接口)

var?out?bytes.Buffer

cmd.Stdout?=?out

//Run執(zhí)行c包含的命令，并阻塞直到完成。??這里stdout被取出，cmd.Wait()無法正確獲取stdin,stdout,stderr，則阻塞在那了

err?:=?cmd.Run()

return?out.String(),?err

}

func?main(){

if?result,err:=exec_shell();err!=nil{

fmt.Println("error:",err)

}else{

fmt.Println("exec?succ?",?result)

}

}

標(biāo)題名稱：執(zhí)行g(shù)o語言程序的命令 go語言執(zhí)行shell
文章路徑：http://jinyejixie.com/article42/dossdec.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供響應(yīng)式網(wǎng)站、網(wǎng)站策劃、網(wǎng)站營銷、網(wǎng)站導(dǎo)航、用戶體驗、網(wǎng)站收錄

廣告

聲明：本網(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)