0

0

如何用Golang开发第一个CLI工具 详解cobra库的入门实践

P粉602998670

P粉602998670

发布时间:2025-07-14 09:42:02

|

637人浏览过

|

来源于php中文网

原创

这篇文章介绍了如何使用go语言和cobra库开发一个命令行工具。首先初始化项目结构,创建go模块并安装cobra库;接着使用cobra-cli init生成基础骨架;然后通过cobra-cli add say添加子命令,并在run函数中实现功能;随后讲解了如何处理位置参数和标志参数,使用args获取输入,并通过intvarp注册标志;最后说明了如何设置short和long字段以提供帮助信息。整个流程清晰,适合初学者入门cli开发。

如何用Golang开发第一个CLI工具 详解cobra库的入门实践

开发一个CLI(命令行)工具是很多Go语言初学者想尝试的方向,而使用Cobra库可以大大简化这个过程。这篇文章不会讲太复杂的概念,而是直接带你用Golang + Cobra写出第一个像样的CLI程序。

如何用Golang开发第一个CLI工具 详解cobra库的入门实践

初始化项目结构

首先你需要一个干净的Go模块环境。创建一个新目录,比如mycli,然后执行:

如何用Golang开发第一个CLI工具 详解cobra库的入门实践
go mod init mycli

接着安装Cobra库:

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

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

Cobra推荐使用它的CLI生成器来初始化项目骨架,你可以先安装它:

如何用Golang开发第一个CLI工具 详解cobra库的入门实践
go install github.com/spf13/cobra-cli@latest

然后运行:

cobra-cli init

这会自动生成一个基础结构,包括cmd/root.go和主函数入口。这时候你已经有一个最简单的CLI应用了,运行go run main.go就能看到默认的帮助信息。

添加子命令

大多数CLI工具都有多个子命令,比如git statusgit commit这种形式。在Cobra中添加子命令非常简单。

假设你想加一个叫say的命令,输出一段话。可以用生成器自动创建:

cobra-cli add say

它会在cmd/目录下生成一个say.go文件。打开这个文件,在Run函数里写上你要做的事情:

func runSay(cmd *cobra.Command, args []string) {
    fmt.Println("Hello from the say command!")
}

现在运行go run main.go say,就会看到你的输出了。

Kotlin Android 中文开发帮助文档 PDF版
Kotlin Android 中文开发帮助文档 PDF版

这本书并不是一本语言参考书,但它是一个Android开发者去学习Kotlin并且使用在自己项目中的一个工具。我会通过使用一些语言特性和有趣的工具和库来解决很多我们在日常生活当中都会遇到的典型问题。 这本书是非常具有实践性的,所以我建议你在电脑面前跟着我的例子和代码实践。无论何时你都可以在有一些想法的时候深入到实践中去。 这本书适合你吗? 写这本书是为了帮助那些有兴趣 使用Kotlin语言来进行开发的Android开发者。 如果你符合下面这些情况,那这本书是适合你的: 你有相关Android开发和Andro

下载

如果你不想用生成器,也可以手动创建命令文件,然后在init()函数里调用rootCmd.AddCommand(...)来注册。

支持参数和标志(Flags)

CLI工具光有命令还不行,还需要能接收用户输入的参数和选项。Cobra支持两种类型的输入:位置参数(positional arguments)和标志(flags)。

位置参数

比如你希望用户输入mycli greet John,其中John就是参数。你可以在命令的Run函数里通过args变量拿到:

func runGreet(cmd *cobra.Command, args []string) {
    if len(args) < 1 {
        fmt.Println("Missing name")
        return
    }
    fmt.Printf("Hello, %s!\n", args[0])
}

标志参数

更常见的是用标志来传递参数,比如--name=John-n John。你可以在命令定义时添加:

var age int

func init() {
    greetCmd.Flags().IntVarP(&age, "age", "a", 0, "your age")
}

这样用户就可以用mycli greet --age=30 John或者mycli greet -a 30 John来传值了。

注意:标志应该在init()函数中注册,并且尽量使用xxxVarP系列函数,方便设置缩写和默认值。

小技巧:帮助和使用提示

Cobra默认会帮你处理-h--help的显示。你只需要在命令中设置好ShortLong字段,用户就能看到清晰的帮助信息。

比如:

greetCmd.Short = "Greet someone"
greetCmd.Long = "Greet someone by their name and optionally their age."

另外,你还可以设置Usage模板来自定义提示格式,不过一般保持默认就够用了。


基本上就这些。用Cobra开发CLI工具并不难,关键在于理解命令结构、参数处理和帮助系统的基本逻辑。一开始可以从一个简单的命令开始,慢慢加上更多功能。你会发现,构建自己的命令行工具其实挺有意思的。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

182

2024.02.23

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

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

229

2024.02.23

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

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

342

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开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

394

2024.05.21

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

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

220

2025.06.09

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

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

193

2025.06.10

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

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

396

2025.06.17

俄罗斯Yandex引擎入口
俄罗斯Yandex引擎入口

2026年俄罗斯Yandex搜索引擎最新入口汇总,涵盖免登录、多语言支持、无广告视频播放及本地化服务等核心功能。阅读专题下面的文章了解更多详细内容。

84

2026.01.28

热门下载

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

精品课程

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

共21课时 | 3.1万人学习

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号