七叶笔记 » golang编程 » golang+cobra开发命令行

golang+cobra开发命令行

Cobra提供了自己的程序,该程序将创建您的应用程序并添加所需的任何命令。

为了使用cobra命令,请使用以下命令进行编译:

  go get github. com /spf13/cobra/cobra  

这将在您的$GOPATH/ bin 目录下创建cobra 可执行文件 cobra命令不存在的话,需要自己配置环境变量。

我们实现的示例如下,仅供参考。

新建项目目录 his-server

  mkdir his_server 
cd his_server 
go mod init his_server  

目录结构如下:

cobra项目初始化

 cobra init --pkg-name his_server  

目录结构如下:

添加子命令

注意:使用camelCase(而不是snake_case / kebab-case)作为命令名称。否则,您将遇到错误。例如,cobra add add-user不正确,但cobra add addUser有效。

  cobra add reportServer  

目录结构如下:

编译运行

  go build 
./his-server  

结果如下:

执行命名后也明显看到了我们新添加的子命令。

添加子命令描述信息

我们在这里修改了短描述信息和长描述信息:

我们再次编译运行:

1 直接 运行命令 会展示短描述提示:

2 执行子命令会执行run 对应的方法体:

3 此时我你们加上-h查看帮助的话,此时可以看到长描述信息和配置文件的路径(可添加作者和许可信息)

此时我们就可以去修改其他的命令信息了,包括默认的rootCmd命令描述也是一样的。

添加子命令选项

编译运行可以直观看出结果:

升级代码,加上gin框架

编译运行:

最后在看下args参数列表

如需深入了解,请看官方资料,这里不在继续了。以后有机会写个详细的专题吧。该休息了^_^!

cobra 仓库地址:

相关文章