0

0

如何用Golang编写第一个CLI工具 详解cobra库的快速入门实践

P粉602998670

P粉602998670

发布时间:2025-08-02 09:33:02

|

804人浏览过

|

来源于php中文网

原创

使用golang和cobra库可以快速构建结构清晰的cli工具。首先安装cobra库,运行go get -u github.com/spf13/cobra/cobra;其次创建项目目录并初始化,用cobra init生成基础结构;接着通过cobra add sayhello添加子命令,并在run函数中实现功能逻辑;随后可在init()中定义flag以支持参数传递;最后运行go build将程序编译为可执行文件并部署到系统路径。以上步骤即可完成一个具备基本功能的cli工具开发。

如何用Golang编写第一个CLI工具 详解cobra库的快速入门实践

用 Golang 编写 CLI 工具其实挺常见的,尤其是当你想做一些自动化脚本或者小型命令行应用的时候。而 cobra 库就是 Go 语言中最流行的一个 CLI 框架,它能帮你快速构建出结构清晰、支持子命令的命令行程序。

如何用Golang编写第一个CLI工具 详解cobra库的快速入门实践

下面我们就一步步来实践一下,怎么用 cobra 写一个简单的 CLI 工具。

如何用Golang编写第一个CLI工具 详解cobra库的快速入门实践

安装 Cobra

首先,你需要安装 cobra 这个库。打开终端,运行:

立即学习go语言免费学习笔记(深入)”;

go get -u github.com/spf13/cobra/cobra

这个命令会把 cobra 的命令行工具也装好,之后你就可以用

cobra
命令来生成项目骨架了。

如何用Golang编写第一个CLI工具 详解cobra库的快速入门实践

安装完成后,你可以输入

cobra --help
看看有没有输出帮助信息,确认是否安装成功。


初始化你的 CLI 项目

接下来我们创建一个目录,比如叫

mycli
,然后进去初始化一个 Cobra 项目:

mkdir mycli && cd mycli
cobra init

执行完后,你会看到项目里多了几个文件和目录,比如

main.go
cmd/root.go
。这些是 cobra 自动生成的基础结构。

你可以先运行一下看看效果:

go run main.go

默认情况下会输出 root 命令的帮助信息,类似这样:

A longer description that spans multiple lines and likely contains
examples and usage of using your application.

别担心,这只是个模板,后面我们会改掉它。


添加一个子命令:sayhello

现在我们来加一个自己的命令,比如

sayhello
,运行它时打印一句“Hello from CLI!”。

用下面这行命令生成一个新命令:

cobra add sayhello

这时候会在

cmd/
目录下多一个
sayhello.go
文件。打开它,找到
Run
函数,在里面加上我们要输出的内容:

viable
viable

基于GPT-4的AI非结构化数据分析平台

下载
func runSayhello(cmd *cobra.Command, args []string) {
    fmt.Println("Hello from CLI!")
}

保存后运行:

go run main.go sayhello

你应该就能看到输出了:

Hello from CLI!

给命令添加参数和 Flag

CLI 工具光有命令还不够,通常还需要传参。我们继续在

sayhello
上扩展,让它支持一个名字参数,比如:

mycli sayhello --name Alice

输出:

Hello, Alice!

要实现这个功能,先在

init()
函数里定义 flag:

var name string

func init() {
    cmd := sayhelloCmd
    cmd.Flags().StringVarP(&name, "name", "n", "World", "Name to greet")
}

然后修改

runSayhello
函数:

func runSayhello(cmd *cobra.Command, args []string) {
    fmt.Printf("Hello, %s!\n", name)
}

现在再运行:

go run main.go sayhello --name Bob

就会输出:

Hello, Bob!

如果你不带参数,默认是

World


构建可执行文件

写好了命令,下一步就是把它打包成一个真正的命令行程序。很简单,只需要运行:

go build -o mycli

之后你就能直接运行:

./mycli sayhello --name Tom

也可以把这个二进制文件放到系统路径里,比如

/usr/local/bin/
,以后就不用带
./
了。


基本上就这些。cobra 的功能还有很多,比如自动补全、配置管理、嵌套命令等,但上面这几步已经足够让你写出一个像样的 CLI 工具了。用起来不复杂,但确实很实用。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

180

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

228

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

340

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

209

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

393

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

197

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

191

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

253

2025.06.17

菜鸟裹裹入口以及教程汇总
菜鸟裹裹入口以及教程汇总

本专题整合了菜鸟裹裹入口地址及教程分享,阅读专题下面的文章了解更多详细内容。

0

2026.01.22

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Git 教程
Git 教程

共21课时 | 2.9万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.5万人学习

Git中文开发手册
Git中文开发手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号