[cli] 从命令行读参数
cli 这个包是 yak 处理命令行参数的工具包，用法非常简单，我们根据实例简单看一下这个包如何使用
获取所有参数
yak 26_cliutil.yak --url https://baidu.com --allow-do-sth --number1 123 --floatvar 1.23 --target "192.168.1.1/24,10.1.3.2/28" --target-port "22,3306,80,8080-8082" --urls "leavesongs.com,10.1.3.2" --urls2 "https://www.baidu.com"
26_cliutil.yak
args = cli.Args() // 获取所有命令行参数内容
dump(args) // 展示参数结果
上述代码执行之后，会展示所有输入的参数：
([]string) (len=17 cap=32) {
(string) (len=3) "yak",
(string) (len=14) "26_cliutil.yak",
(string) (len=5) "--url",
(string) (len=17) "https://baidu.com",
(string) (len=14) "--allow-do-sth",
(string) (len=9) "--number1",
(string) (len=3) "123",
(string) (len=10) "--floatvar",
(string) (len=4) "1.23",
(string) (len=8) "--target",
(string) (len=26) "192.168.1.1/24,10.1.3.2/28",
(string) (len=13) "--target-port",
(string) (len=20) "22,3306,80,8080-8082",
(string) (len=6) "--urls",
(string) (len=23) "leavesongs.com,10.1.3.2",
(string) (len=7) "--urls2",
(string) (len=21) "https://www.baidu.com"
}
cli 处理不同类型的参数值
cli.String： 处理字符串类型参数
// > yakc clitest.yak --url https://baidu.com
strParam = cli.String("url")
dump(strParam)
通过执行 dump(strParam) 可以看到参数类型与值
(string) (len=17) "https://baidu.com"
cli.Bool：处理 Bool 类型参数
boolParam = cli.Bool("allow-do-sth")
dump(boolParam)
注意
cli.Bool(paramName) 不会获取参数的值，只会检测命令行中有没有当前参数，如果有的话，返回值为 true 否则为 false;
cli.Int：处理整数参数
intParam = cli.Int("number1")
dump(intParam)
cli.Float：处理浮点参数
floatParam = cli.Float("floatvar")
dump(floatParam)
设置短参数别名
如以下代码, 通过在第一个参数中传入短参数名 长参数名来设置短参数别名:
// -t example.com 或 --target example.com
target = cli.String("t target")
print(target)
cli 处理扩展数据类型
cli.Hosts：处理参数是网段的情况
// --target "192.168.1.1/24,10.1.3.2/28"
netParam = cli.Hosts("target")
dump(netParam)
上述脚本执行结果为
/*
展示结果
([]string) (len=272 cap=512) {
(string) (len=11) "192.168.1.0",
(string) (len=11) "192.168.1.1",
......
......
(string) (len=13) "192.168.1.253",
(string) (len=13) "192.168.1.254",
(string) (len=13) "192.168.1.255",
(string) (len=8) "10.1.3.0",
......
(string) (len=9) "10.1.3.14",
(string) (len=9) "10.1.3.15"
}
*/
cli.Ports：处理扫描端口组参数
// --target-port "22,3306,80,8080-8082"
portParam = cli.Ports("target-port")
dump(portParam)
上述脚本执行结果为
([]int) (len=6 cap=8) {
(int) 22,
(int) 80,
(int) 3306,
(int) 8080,
(int) 8081,
(int) 8082
}
备注
本质上执行了 str.ParseStringToPorts
cli.Urls：处理目标是 url 的情况
案例：解析 urls，自由解析
// --urls "leavesongs.com,10.1.3.2,https://www.baidu.com"
urlParam = cli.Urls("urls")
dump(urlParam)
解析结果为 urls
([]string) (len=6 cap=8) {
(string) (len=22) "https://leavesongs.com",
(string) (len=26) "https://www.leavesongs.com",
(string) (len=21) "http://leavesongs.com",
(string) (len=25) "http://www.leavesongs.com",
(string) (len=16) "https://10.1.3.2",
(string) (len=15) "http://10.1.3.2"
}
案例：解析 urls，直接解析 URL
// --urls2 "https://www.baidu.com"
println("-----------------------------------------")
urlParam = cli.Urls("urls2")
dump(urlParam)
/*
([]string) (len=1 cap=1) {
(string) (len=21) "https://www.baidu.com"
}
*/
默认值/帮助/文档/参数检查
可用的函数有:
cli.SetDoc(doc: string)设置文档信息，注意S是大写cli.help(w...: io.Writer)显示帮助信息, w是可选参数，为io.Writer,默认是os.Stdout
目前可设置的命令行参数属性为：
cli.setDefault(defaultValue: any)设置默认值cli.setRequired(required: bool)设置是否为必需参数，如果必须参数缺失，则可以通过cli.check()来检查合理性，帮助截断执行过程cli.setHelp(helpInfo: string)设置帮助信息
注意
如果需要检查参数是否合理，我们需要通过 cli.check() 函数来操作，如果这个参数检查不合理，则会立即退出程序。
如果不调用cli.check()函数，那么即使参数不合理也不会有显示或结束进程。
另外，如果不调用cli.check()函数，那么也不会解析-h, --help 来输出帮助信息。
实战案例，生成帮助信息
Yak cli 模块中，我们经常需要为我们的脚本设置参数，同为我们脚本设置帮助信息，方便别人来使用。
cli.SetDoc(`这是一个程序文档信息`)
testValue = cli.String("t target", cli.setRequired(true), cli.setHelp("这是一个扫描目标，是必要参数"))
boolParams = cli.Bool("b bool-params", cli.setHelp("这是一个bool值"))
strValue = cli.String("testOrdinaryParam")
cli.check()
println("param parsed")
我们编写了上述代码，将会从命令行取出一些参数来执行，如果我们不输入参数，直接执行，将会出现如下效果:
Error:
Parameter [target] error: miss parameter
Usage:
test [OPTIONS]
这是一个程序文档信息
Flags:
-h, --help Show help information
-t, --target string 这是一个扫描目标，是必要参数
-b, --bool-params 这是一个bool值
--testOrdinaryParam string