寫了2次才寫完,內(nèi)容很長(zhǎng),翻譯了很久,內(nèi)容來(lái)源于Cobra github介紹。翻譯完也更全面的了解了Cobra,功能相當(dāng)強(qiáng)大完善,各種使用的場(chǎng)景都考慮到了。另外也擴(kuò)展了一些其它知識(shí),比如 命令行玩法 , Levenshtein distance 等等。以下是正文:
公司主營(yíng)業(yè)務(wù):網(wǎng)站設(shè)計(jì)制作、做網(wǎng)站、移動(dòng)網(wǎng)站開發(fā)等業(yè)務(wù)。幫助企業(yè)客戶真正實(shí)現(xiàn)互聯(lián)網(wǎng)宣傳,提高企業(yè)的競(jìng)爭(zhēng)能力。成都創(chuàng)新互聯(lián)公司是一支青春激揚(yáng)、勤奮敬業(yè)、活力青春激揚(yáng)、勤奮敬業(yè)、活力澎湃、和諧高效的團(tuán)隊(duì)。公司秉承以“開放、自由、嚴(yán)謹(jǐn)、自律”為核心的企業(yè)文化,感謝他們對(duì)我們的高要求,感謝他們從不同領(lǐng)域給我們帶來(lái)的挑戰(zhàn),讓我們激情的團(tuán)隊(duì)有機(jī)會(huì)用頭腦與智慧不斷的給客戶帶來(lái)驚喜。成都創(chuàng)新互聯(lián)公司推出平泉免費(fèi)做網(wǎng)站回饋大家。
Cobra提供簡(jiǎn)單的接口來(lái)創(chuàng)建強(qiáng)大的現(xiàn)代化CLI接口,比如git與go工具。Cobra同時(shí)也是一個(gè)程序, 用于創(chuàng)建CLI程序
Cobra是建立在結(jié)構(gòu)的命令、參數(shù)和標(biāo)志之上。
命令代表操作,參數(shù)和標(biāo)志是這些行動(dòng)的修飾符。
最好的應(yīng)用程序就像讀取句子。用戶會(huì)知道如何使用本機(jī)應(yīng)用程序,因?yàn)樗麄儗⒗斫馊绾问褂盟?/p>
比如下面的例子, server 是命令, port 是標(biāo)志:
在下面的命令,我們告訴Git克隆url地址bare
使用Cobra很簡(jiǎn)單。首先,使用 go get 安裝最新版本
然后在你項(xiàng)目里引用Cobra
通?;贑obra的應(yīng)用程序?qū)⒆裱旅娴慕M織結(jié)構(gòu),當(dāng)然你也可以遵循自己的接口:
在Cobra應(yīng)用程序中,通常main.go文件非??斩础K饕桓梢患拢撼跏蓟疌obra。
Cobra提供自己的程序來(lái)創(chuàng)建你的程序并且添加你想要的命令。這是最簡(jiǎn)單的方式把Cobra添加到你的程序里。
這里 你能找到相關(guān)信息
使用Cobra,需要?jiǎng)?chuàng)建一個(gè)空的main.go文件和一個(gè)rootCmd文件。你可以選擇在合適的地方添加額外的命令。
Cobra不需要特殊的構(gòu)造函數(shù)。簡(jiǎn)單的就可以創(chuàng)建你的命令。
理想情況下你把這個(gè)放在在 app/cmd/root.go
你會(huì)另外定義標(biāo)志和處理配置init()函數(shù)。
比如 cmd/root.go
你需要在main函數(shù)里執(zhí)行root命令。
通常main.go文件非??斩?。它主要只干一件事:初始化Cobra。
其它的命令通常定義在cmd/目錄下的自己文件內(nèi)
如果你想創(chuàng)建一個(gè)version命令,你可以創(chuàng)建cmd/version.go文件,并在文件里這么寫:
標(biāo)志提供修飾符控制動(dòng)作命令如何操作
當(dāng)標(biāo)志定義好了,我們需要定義一個(gè)變量來(lái)關(guān)聯(lián)標(biāo)志
'持久'表示每個(gè)在那個(gè)命令下的命令都將能分配到這個(gè)標(biāo)志。對(duì)于全局標(biāo)志,'持久'的標(biāo)志綁定在root上。
Cobra默認(rèn)只在目標(biāo)命令上解析標(biāo)志,父命令忽略任何局部標(biāo)志。通過(guò)打開 Command.TraverseChildren Cobra將會(huì)在執(zhí)行任意目標(biāo)命令前解析標(biāo)志
你同樣可以通過(guò) viper 綁定標(biāo)志:
在這個(gè)例子中,永久的標(biāo)記 author 被 viper 綁定, 注意 , 當(dāng)用戶沒(méi)有給 --author 提供值, author 不會(huì)被賦值。
標(biāo)記默認(rèn)是可選的,如果你希望當(dāng)一個(gè)標(biāo)記沒(méi)有設(shè)置時(shí),命令行報(bào)錯(cuò),你可以標(biāo)記它為必須的
驗(yàn)證位置參數(shù)可以通過(guò) Command 的 Args 字段。
內(nèi)置下列驗(yàn)證方法
一個(gè)設(shè)置自定義驗(yàn)證的例子
在下面的例子,我們定義了3個(gè)命令。2個(gè)在頂級(jí),一個(gè)(cmdTimes)是其中一個(gè)頂級(jí)命令的子命令。在這個(gè)例子里,由于沒(méi)有給 rootCmd 提供 Run ,單獨(dú)的root是不能運(yùn)行的,必須要有子命令。
我們僅為一個(gè)命令定義了標(biāo)記。
更多關(guān)于flags的文檔可以在 找到
更完整大型程序的例子, 可以查看 Hugo .
當(dāng)你的程序有子命令時(shí),Cobra 會(huì)自動(dòng)給你程序添加help命令。當(dāng)你運(yùn)行‘a(chǎn)pp help’,會(huì)調(diào)用help命令。另外,help同樣支持其它輸入命令。例如,你有一個(gè)沒(méi)有任何其它配置的命令叫‘create’,當(dāng)你調(diào)用‘a(chǎn)pp help create’ Corbra 將會(huì)起作用。
下面的輸入是 Cobra 自動(dòng)生成的。除了命令和標(biāo)志的定義,其它不再需要。
help 就跟其它命令一樣,并沒(méi)有特殊的邏輯或行為。事實(shí)上,你也可以提供你自己help如果你想的話。
你能為默認(rèn)的命令,提供你自己的help命令或模板。使用下面的方法:
后2個(gè)也將適用于任何子命令
當(dāng)用戶提供無(wú)效的標(biāo)記或命令,Cobra 將會(huì)返回 用法 。
你可能從上面的幫助意識(shí)到,默認(rèn)的幫助將被嵌入到用法里然后作為輸出。
你能提供你自己的用法函數(shù)或模板給 Cobra 使用。
比如幫助,方法和模板都可以重寫。
如果Version字段設(shè)置到了根命令,Cobra 會(huì)提供了一個(gè)頂層 ‘--version’標(biāo)記。運(yùn)行帶上‘--version’標(biāo)記的程序,將會(huì)按照模板版本信息。模板可以通過(guò) cmd.SetVersionTemplate(s string) 方法修改
在命令運(yùn)行前或運(yùn)行后,再運(yùn)行方法非常容易。 PersistentPreRun 和 PreRun 方法將會(huì)在 Run 之前執(zhí)行。 PersistentPostRun 和 PostRun 方法將會(huì)在 Run 之后執(zhí)行。 Persistent*Run 方法會(huì)被子命令繼承,如果它們自己沒(méi)有定義的話。這些方法將按照下面的屬性執(zhí)行:
下面的例子,2個(gè)命令都使用了上面的特性。當(dāng)子命令執(zhí)行的時(shí)候,它將執(zhí)行根命令的 PersistentPreRun ,但不會(huì)執(zhí)行根命令的 PersistentPostRun :
輸出:
Cobra 會(huì)自動(dòng)輸出建議,當(dāng)遇到“unknown command”錯(cuò)誤時(shí)。這使得當(dāng)輸入錯(cuò)誤時(shí), Cobra 的行為類似 git 命令。例如:
建議會(huì)基于注冊(cè)的子命令自動(dòng)生成。使用了 Levenshtein distance 的實(shí)現(xiàn)。每一個(gè)注冊(cè)的命令會(huì)匹配2個(gè)距離(忽略大小寫)來(lái)提供建議。
如果你希望在你的命令里,禁用建議或虛弱字符串的距離,使用:
或
你可以通過(guò) SuggestFor 來(lái)給命令提供明確的名詞建議。這個(gè)特性允許當(dāng)字符串不相近,但是意思與你的命令相近,別切你也不想給該命令設(shè)置別名。比如:
Cobra 可以基于子命令,標(biāo)記,等生成文檔。以以下格式:
Cobra 可以生成一個(gè)bash-completion文件。如果你給命令添加更多信息,這些completions可以非常強(qiáng)大和靈活。更多介紹在 Bash Completions 。
本教程介紹了使用 Godatabase/sql及其標(biāo)準(zhǔn)庫(kù)中的包訪問(wèn)關(guān)系數(shù)據(jù)庫(kù)的基礎(chǔ)知識(shí)。
您將使用的database/sql包包括用于連接數(shù)據(jù)庫(kù)、執(zhí)行事務(wù)、取消正在進(jìn)行的操作等的類型和函數(shù)。
在本教程中,您將創(chuàng)建一個(gè)數(shù)據(jù)庫(kù),然后編寫代碼來(lái)訪問(wèn)該數(shù)據(jù)庫(kù)。您的示例項(xiàng)目將是有關(guān)老式爵士樂(lè)唱片的數(shù)據(jù)存儲(chǔ)庫(kù)。
首先,為您要編寫的代碼創(chuàng)建一個(gè)文件夾。
1、打開命令提示符并切換到您的主目錄。
在 Linux 或 Mac 上:
在 Windows 上:
2、在命令提示符下,為您的代碼創(chuàng)建一個(gè)名為 data-access 的目錄。
3、創(chuàng)建一個(gè)模塊,您可以在其中管理將在本教程中添加的依賴項(xiàng)。
運(yùn)行g(shù)o mod init命令,為其提供新代碼的模塊路徑。
此命令創(chuàng)建一個(gè) go.mod 文件,您添加的依賴項(xiàng)將在其中列出以供跟蹤。
注意: 在實(shí)際開發(fā)中,您會(huì)指定一個(gè)更符合您自己需求的模塊路徑。有關(guān)更多信息,請(qǐng)參閱一下文章。
GO語(yǔ)言(二十五):管理依賴項(xiàng)(上)
GO語(yǔ)言(二十六):管理依賴項(xiàng)(中)
GO語(yǔ)言(二十七):管理依賴項(xiàng)(下)
接下來(lái),您將創(chuàng)建一個(gè)數(shù)據(jù)庫(kù)。
在此步驟中,您將創(chuàng)建要使用的數(shù)據(jù)庫(kù)。您將使用 DBMS 本身的 CLI 創(chuàng)建數(shù)據(jù)庫(kù)和表,以及添加數(shù)據(jù)。
您將創(chuàng)建一個(gè)數(shù)據(jù)庫(kù),其中包含有關(guān)黑膠唱片上的老式爵士樂(lè)錄音的數(shù)據(jù)。
這里的代碼使用MySQL CLI,但大多數(shù) DBMS 都有自己的 CLI,具有類似的功能。
1、打開一個(gè)新的命令提示符。
在命令行,登錄到您的 DBMS,如下面的 MySQL 示例所示。
2、在mysql命令提示符下,創(chuàng)建一個(gè)數(shù)據(jù)庫(kù)。
3、切到您剛剛創(chuàng)建的數(shù)據(jù)庫(kù),以便您可以添加表。
4、在文本編輯器的 data-access 文件夾中,創(chuàng)建一個(gè)名為 create-tables.sql 的文件來(lái)保存用于添加表的 SQL 腳本。
將以下 SQL 代碼粘貼到文件中,然后保存文件。
在此 SQL 代碼中:
(1)刪除名為album表。 首先執(zhí)行此命令可以讓您更輕松地稍后重新運(yùn)行腳本。
(2)創(chuàng)建一個(gè)album包含四列的表:title、artist和price。每行的id值由 DBMS 自動(dòng)創(chuàng)建。
(3)添加帶有值的四行。
5、在mysql命令提示符下,運(yùn)行您剛剛創(chuàng)建的腳本。
您將使用以下形式的source命令:
6、在 DBMS 命令提示符處,使用SELECT語(yǔ)句來(lái)驗(yàn)證您是否已成功創(chuàng)建包含數(shù)據(jù)的表。
接下來(lái),您將編寫一些 Go 代碼進(jìn)行連接,以便進(jìn)行查詢。
現(xiàn)在你已經(jīng)有了一個(gè)包含一些數(shù)據(jù)的數(shù)據(jù)庫(kù),開始你的 Go 代碼。
找到并導(dǎo)入一個(gè)數(shù)據(jù)庫(kù)驅(qū)動(dòng)程序,該驅(qū)動(dòng)程序會(huì)將您通過(guò)database/sql包中的函數(shù)發(fā)出的請(qǐng)求轉(zhuǎn)換為數(shù)據(jù)庫(kù)可以理解的請(qǐng)求。
1、在您的瀏覽器中,訪問(wèn)SQLDrivers wiki 頁(yè)面以識(shí)別您可以使用的驅(qū)動(dòng)程序。
2、使用頁(yè)面上的列表來(lái)識(shí)別您將使用的驅(qū)動(dòng)程序。為了在本教程中訪問(wèn) MySQL,您將使用 Go-MySQL-Driver。
3、請(qǐng)注意驅(qū)動(dòng)程序的包名稱 - 此處為github.com/go-sql-driver/mysql.
4、使用您的文本編輯器,創(chuàng)建一個(gè)用于編寫 Go 代碼的文件,并將該文件作為 main.go 保存在您之前創(chuàng)建的數(shù)據(jù)訪問(wèn)目錄中。
5、進(jìn)入main.go,粘貼以下代碼導(dǎo)入驅(qū)動(dòng)包。
在此代碼中:
(1)將您的代碼添加到main包中,以便您可以獨(dú)立執(zhí)行它。
(2)導(dǎo)入 MySQL 驅(qū)動(dòng)程序github.com/go-sql-driver/mysql。
導(dǎo)入驅(qū)動(dòng)程序后,您將開始編寫代碼以訪問(wèn)數(shù)據(jù)庫(kù)。
現(xiàn)在編寫一些 Go 代碼,讓您使用數(shù)據(jù)庫(kù)句柄訪問(wèn)數(shù)據(jù)庫(kù)。
您將使用指向結(jié)構(gòu)的指針sql.DB,它表示對(duì)特定數(shù)據(jù)庫(kù)的訪問(wèn)。
編寫代碼
1、進(jìn)入 main.go,在import您剛剛添加的代碼下方,粘貼以下 Go 代碼以創(chuàng)建數(shù)據(jù)庫(kù)句柄。
在此代碼中:
(3)使用 MySQL 驅(qū)動(dòng)程序Config和FormatDSN類型以收集連接屬性并將它們格式化為連接字符串的 DSN。
該Config結(jié)構(gòu)使代碼比連接字符串更容易閱讀。
(4)調(diào)用sql.Open 初始化db變量,傳遞 FormatDSN。
(5)檢查來(lái)自 的錯(cuò)誤sql.Open。例如,如果您的數(shù)據(jù)庫(kù)連接細(xì)節(jié)格式不正確,它可能會(huì)失敗。
為了簡(jiǎn)化代碼,您調(diào)用log.Fatal結(jié)束執(zhí)行并將錯(cuò)誤打印到控制臺(tái)。在生產(chǎn)代碼中,您會(huì)希望以更優(yōu)雅的方式處理錯(cuò)誤。
(6)調(diào)用DB.Ping以確認(rèn)連接到數(shù)據(jù)庫(kù)有效。在運(yùn)行時(shí), sql.Open可能不會(huì)立即連接,具體取決于驅(qū)動(dòng)程序。您在Ping此處使用以確認(rèn) database/sql包可以在需要時(shí)連接。
(7)檢查來(lái)自Ping的錯(cuò)誤,以防連接失敗。
(8)Ping如果連接成功,則打印一條消息。
文件的頂部現(xiàn)在應(yīng)該如下所示:
3、保存 main.go。
1、開始跟蹤 MySQL 驅(qū)動(dòng)程序模塊作為依賴項(xiàng)。
使用go get 添加 github.com/go-sql-driver/mysql 模塊作為您自己模塊的依賴項(xiàng)。使用點(diǎn)參數(shù)表示“獲取當(dāng)前目錄中代碼的依賴項(xiàng)”。
2、在命令提示符下,設(shè)置Go 程序使用的DBUSER和DBPASS環(huán)境變量。
在 Linux 或 Mac 上:
在 Windows 上:
3、在包含 main.go 的目錄中的命令行中,通過(guò)鍵入go run來(lái)運(yùn)行代碼。
連接成功了!
接下來(lái),您將查詢一些數(shù)據(jù)。
cobra是一個(gè)提供簡(jiǎn)單接口來(lái)創(chuàng)建強(qiáng)大的現(xiàn)代CLI界面的庫(kù)類似git git tools,cobra也是一個(gè)應(yīng)用程序,它會(huì)生成你的應(yīng)用程序的腳手架來(lái)快速開發(fā)基于cobra的應(yīng)用程序
cobra提供:
cobra建立在命令、參數(shù)、標(biāo)志的結(jié)構(gòu)之上
commands代表動(dòng)作,args是事物,flags是動(dòng)作的修飾符
最好的應(yīng)用程序在使用時(shí)讀起來(lái)就像句子,因此,用戶直觀地知道如何與它們交互
模式如下:APPNAME VERB NOUN --ADJECTIVE. or APPNAME COMMAND ARG --FLAG(APPNAME 動(dòng)詞 名詞 形容詞 或者 APPNAME 命令 參數(shù) 標(biāo)志)
一些真實(shí)世界的好例子可以更好地說(shuō)明這一點(diǎn)
kubectl 命令更能體現(xiàn)APPNAME 動(dòng)詞 名詞 形容詞
如下的例子,server 是command,port是flag
這個(gè)命令中,我們告訴git 克隆url
命令是應(yīng)用程序的中心點(diǎn),應(yīng)用程序支持的每一個(gè)交互都包含在一個(gè)命令中,命令可以有子命令,也可以運(yùn)行操作
在上面的例子中,server是命令
更多關(guān)于cobra.Command
flag是一種修改命令行為的方式,cobra支持完全兼容POSIX標(biāo)志,也支持go flag package,cobra可以定義到子命令上的標(biāo)志,也可以僅對(duì)該命令可用的標(biāo)志
在上面的命令中,port是標(biāo)志
標(biāo)志的功能由 pflag library 提供,pflag library是flag標(biāo)準(zhǔn)庫(kù)的一個(gè)分支,在添加POSIX兼容性的同時(shí)維護(hù)相同的接口。
使用cobra很簡(jiǎn)單,首先,使用go get按照最新版本的庫(kù),這個(gè)命令會(huì)安裝cobra可執(zhí)行程序以及庫(kù)和依賴項(xiàng)
下一步,引入cobra到應(yīng)用程序中
雖然歡迎您提供自己的組織,但通?;贑obra的應(yīng)用程序?qū)⒆裱韵陆M織結(jié)構(gòu):
在Cobra應(yīng)用程序中,main.go文件通常非常簡(jiǎn)單。它有一個(gè)目的:初始化Cobra。
使用cobra生成器
cobra提供了程序用來(lái)創(chuàng)建你的應(yīng)用程序然后添加你想添加的命令,這是將cobra引入應(yīng)用程序最簡(jiǎn)單的方式
這兒 你可以發(fā)現(xiàn)關(guān)于cobra的更多信息
要手動(dòng)實(shí)現(xiàn)cobra,需要?jiǎng)?chuàng)建一個(gè)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)該在根目錄下運(yùn)行,盡管它可以在任何命令上調(diào)用。
在Cobra應(yīng)用程序中,main.go文件通常非常簡(jiǎn)單。它有一個(gè)目的:初始化Cobra。
可以定義其他命令,通常每個(gè)命令在cmd/目錄中都有自己的文件。
如果要?jiǎng)?chuàng)建版本命令,可以創(chuàng)建cmd/version.go并用以下內(nèi)容填充它:
如果希望將錯(cuò)誤返回給命令的調(diào)用者,可以使用RunE。
然后可以在execute函數(shù)調(diào)用中捕獲錯(cuò)誤。
標(biāo)志提供修飾符來(lái)控制操作命令的操作方式。
由于標(biāo)志是在不同的位置定義和使用的,因此我們需要在外部定義一個(gè)具有正確作用域的變量來(lái)分配要使用的標(biāo)志。
有兩種不同的方法來(lái)分配標(biāo)志。
標(biāo)志可以是“持久”的,這意味著該標(biāo)志將可用于分配給它的命令以及該命令下的每個(gè)命令。對(duì)于全局標(biāo)志,在根上指定一個(gè)標(biāo)志作為持久標(biāo)志。
也可以在本地分配一個(gè)標(biāo)志,該標(biāo)志只應(yīng)用于該特定命令。
默認(rèn)情況下,Cobra只解析目標(biāo)命令上的本地標(biāo)志,而忽略父命令上的任何本地標(biāo)志。通過(guò)啟用Command.TraverseChildren,Cobra將在執(zhí)行目標(biāo)命令之前解析每個(gè)命令上的本地標(biāo)志。
使用viper綁定標(biāo)志
在本例中,持久標(biāo)志author與viper綁定。注意:當(dāng)用戶未提供--author標(biāo)志時(shí),變量author將不會(huì)設(shè)置為config中的值。
更多關(guān)于 viper的文檔
Flags默認(rèn)是可選的,如果希望命令在未設(shè)置標(biāo)志時(shí)報(bào)告錯(cuò)誤,請(qǐng)根據(jù)需要進(jìn)行標(biāo)記:
持久性Flags
可以使用命令的Args字段指定位置參數(shù)的驗(yàn)證。
內(nèi)置了以下驗(yàn)證器:
在下面的示例中,我們定義了三個(gè)命令。兩個(gè)是頂級(jí)命令,一個(gè)(cmdTimes)是頂級(jí)命令之一的子命令。在這種情況下,根是不可執(zhí)行的,這意味著需要一個(gè)子命令。這是通過(guò)不為“rootCmd”提供“Run”來(lái)實(shí)現(xiàn)的。
我們只為一個(gè)命令定義了一個(gè)標(biāo)志。
有關(guān)標(biāo)志的更多文檔,請(qǐng)?jiān)L問(wèn)
對(duì)于一個(gè)更完整的例子更大的應(yīng)用程序,請(qǐng)檢查 Hugo 。
當(dāng)您有子命令時(shí),Cobra會(huì)自動(dòng)將help命令添加到應(yīng)用程序中。當(dāng)用戶運(yùn)行“應(yīng)用程序幫助”時(shí),將調(diào)用此函數(shù)。此外,help還支持所有其他命令作為輸入。例如,您有一個(gè)名為“create”的命令,沒(méi)有任何附加配置;調(diào)用“app help create”時(shí),Cobra將起作用。每個(gè)命令都會(huì)自動(dòng)添加“-help”標(biāo)志。
以下輸出由Cobra自動(dòng)生成。除了命令和標(biāo)志定義之外,不需要任何東西。
幫助就像其他命令一樣。它周圍沒(méi)有特殊的邏輯或行為。事實(shí)上,你可以提供你想提供的。
您可以為默認(rèn)命令提供自己的幫助命令或模板,以用于以下功能:
當(dāng)用戶提供無(wú)效的標(biāo)志或無(wú)效的命令時(shí),Cobra通過(guò)向用戶顯示“用法”來(lái)響應(yīng)。
你可以從上面的幫助中認(rèn)識(shí)到這一點(diǎn)。這是因?yàn)槟J(rèn)幫助將用法作為其輸出的一部分嵌入。
您可以提供自己的使用函數(shù)或模板供Cobra使用。與幫助一樣,函數(shù)和模板也可以通過(guò)公共方法重寫:
如果在root命令上設(shè)置了version字段,Cobra會(huì)添加一個(gè)頂級(jí)的'--version'標(biāo)志。運(yùn)行帶有“-version”標(biāo)志的應(yīng)用程序?qū)⑹褂冒姹灸0鍖姹敬蛴〉綐?biāo)準(zhǔn)輸出。可以使用cmd.SetVersionTemplate(s string)函數(shù)自定義模板。
可以在命令的主運(yùn)行函數(shù)之前或之后運(yùn)行函數(shù)。PersistentPreRun和PreRun函數(shù)將在運(yùn)行之前執(zhí)行。PersistentPostRun和PostRun將在運(yùn)行后執(zhí)行。如果子函數(shù)不聲明自己的函數(shù),則它們將繼承Persistent*Run函數(shù)。這些函數(shù)按以下順序運(yùn)行:
輸出:
當(dāng)發(fā)生“未知命令”錯(cuò)誤時(shí),Cobra將打印自動(dòng)建議。這使得Cobra在發(fā)生拼寫錯(cuò)誤時(shí)的行為類似于git命令。例如:
基于注冊(cè)的每個(gè)子命令和Levenshtein距離的實(shí)現(xiàn),建議是自動(dòng)的。匹配最小距離2(忽略大小寫)的每個(gè)已注冊(cè)命令都將顯示為建議。
如果需要在命令中禁用建議或調(diào)整字符串距離,請(qǐng)使用:
or
您還可以使用SuggestFor屬性顯式設(shè)置將為其建議給定命令的名稱。這允許對(duì)在字符串距離方面不接近的字符串提供建議,但在您的一組命令中是有意義的,并且對(duì)于某些您不需要?jiǎng)e名的字符串。例子:
Cobra可以基于子命令、標(biāo)志等生成文檔。請(qǐng)?jiān)?docs generation文檔 中閱讀更多關(guān)于它的信息。
Cobra可以為以下shell生成shell完成文件:bash、zsh、fish、PowerShell。如果您在命令中添加更多信息,這些補(bǔ)全功能將非常強(qiáng)大和靈活。在 Shell Completions 中閱讀更多關(guān)于它的信息。
Cobra is released under the Apache 2.0 license. See LICENSE.txt