GOLang CLI

GOLang CLI

刚接触GoLang,发现大家在写CLI的时候都会直接使用Go语言中自动的flag或者cobra。想着自己以后接触Go的机会会非常多,所以今天就进行总结。

Cobra

其实就是翻译Cobra的README内容https://github.com/spf13/cobra,不过对应的中文翻译https://o-my-chenjian.com/2017/09/20/Using-Cobra-With-Golang/

基本概念这里不过多的叙述,也就是commands,arguments,和flags

Generator的使用

这里主要介绍下Generator,因为Generator是一个非常好用的工具,可以非常方便的添加commands。

基本命令

cobra init:初始化

cobra add:添加子command

把cobra作为lib使用

添加子command

这个部分比较简单,在使用的过程中直接创建对应的command即可

使用flags

不过flags有多种类型:

1. Persistent

可以被当前的command使用,也可以被其child command(sub command)使用

2. Local

只能被当前command识别使用

3. Local Flag on Parent Commands

Command.TraverseChildren,如果不设置这个,local的flag在parent command会被ignore

4. Bind Flags with Config


5. Required flags

rootCmd.MarkFlagRequired("region")

6. 配置command的arg内容
https://github.com/spf13/cobra#positional-and-custom-arguments

GoLang自带

go lang中自带了command-line的一些工具,最常用的就是针对一个cli的argument和cli对应的options。以及两者的联合使用

arguments

首先会用到的就是一个CLI的argument。可以直接通过

args:=os.Args

返回的args是一个slice,slice的第一个元素是程序的path,也就是运行这个go程序的相对路径。args[1:]才是后边的args。参数按照空格的方式分割。

flag

经常使用还有CLI的一些option的内容,也就是根据flag获得对应flag的参数。

flag的实现是封装了CommandLine,CommandLine(其实就是一个FlagSet)中封装了多个flags,这些flags都是从os.args中转换出来的。一般都只会使用一些顶层接口,比如BoolVar,Arg

示例

var wordPtr = flag.String("word", "foo", "a string")
var numbPtr = flag.Int("numb", 42, "an int")
var boolPtr = flag.Bool("fork",false,"a bool")
func main() {
    flag.Parse()
    fmt.Println("word:", *wordPtr)
    fmt.Println("numb:", *numbPtr)
    fmt.Println("fork:", *boolPtr)
    
}

会根据flag的内容输出对应的option的结果。

flag和argument交叉使用

按照flag的例子接着使用一些argument的内容

var wordPtr = flag.String("word", "foo", "a string")
var numbPtr = flag.Int("numb", 42, "an int")
var boolPtr = flag.Bool("fork",false,"a bool")
func main() {
    flag.Parse()
    fmt.Println("word:", *wordPtr)
    fmt.Println("numb:", *numbPtr)
    fmt.Println("fork:", *boolPtr)
    
    fmt.Println("tail:", flag.Args())
    fmt.Println(flag.NArg())
    fmt.Println(flag.NFlag())
    fmt.Println(flag.Arg(2))
    args:=os.Args
    fmt.Println(args)
}

调用命令的方式为./main -word=word -fork=true 1 2 3 4

最终的结果是flag对应的Arg内容是最后的参数内容。但是os.Args还是按照arguments的规则来区分的。

注意在使用的时候options的内容(也就是flag的内容)在前边,arguments的内容在后边。这样可以直接使用flag来转化得到options和argument的内容。

pflag

pflag的基本功能和flag相同,但是支持一些更丰富的操作。

  1. 多种数据类型

  2. 支持更多种类型的参数,以及slice类型

  3. 支持shorthand,deprecated,hidden

一些特殊的需求可以使用pflag来实现。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,133评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,682评论 3 390
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,784评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,508评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,603评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,607评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,604评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,359评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,805评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,121评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,280评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,959评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,588评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,206评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,442评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,193评论 2 367
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,144评论 2 352

推荐阅读更多精彩内容