Go语言适合开发命令行工具,基础场景可用flag包解析参数,如定义-msg和-count输出指定内容;复杂多命令结构推荐spf13/cobra库,支持子命令、自动帮助与补全,示例中构建了todo应用,包含add子命令添加任务,并可通过viper集成配置、survey实现交互、zap记录日志,结合SQLite持久化数据,打造完整CLI工具。

Go语言因其简洁的语法和强大的标准库,非常适合开发命令行工具(CLI)。通过内置的 flag 包和第三方库如 spf13/cobra,可以快速构建功能完整、结构清晰的 CLI 应用。下面从基础到实战,介绍如何用 Golang 开发命令行工具。
使用 flag 包实现简单 CLI
Go 的标准库 flag 包支持解析命令行参数,适合轻量级工具。
示例:创建一个输出消息和次数的命令行程序
package main
import (
"fmt"
"flag"
)
func main() {
msg := flag.String("msg", "Hello", "要输出的信息")
count := flag.Int("count", 1, "输出次数")
flag.Parse()
for i := 0; i < *count; i++ {
fmt.Println(*msg)
}
}
运行:go run main.go -msg="Hi" -count=3
输出 3 次 "Hi"。
flag 支持字符串、整型、布尔等类型,并自动生成帮助信息(-h)。
使用 Cobra 构建复杂 CLI 工具
对于多命令、子命令结构(如 git、docker),推荐使用 spf13/cobra。它提供命令注册、自动帮助、自动补全等功能。
立即学习“go语言免费学习笔记(深入)”;
安装 cobra:
go get -u github.com/spf13/cobra@latest
使用 cobra-cli 初始化(可选):
- 安装 cli 工具:
go install github.com/spf13/cobra-cli@latest - 生成根命令:
cobra-cli init - 添加子命令:
cobra-cli add serve
package main
import "todo/cmd"
func main() {
cmd.Execute()
}
cmd/root.go
package cmd
import (
"fmt"
"github.com/spf13/cobra"
)
var rootCmd = &cobra.Command{
Use: "todo",
Short: "一个简单的待办事项工具",
Long: `支持添加、列出、删除任务`,
}
func Execute() {
if err := rootCmd.Execute(); err != nil {
fmt.Println(err)
return
}
}
cmd/add.go(添加子命令)
package cmd
import (
"fmt"
"github.com/spf13/cobra"
)
var addCmd = &cobra.Command{
Use: "add",
Short: "添加一个新任务",
Run: func(cmd *cobra.Command, args []string) {
if len(args) == 0 {
fmt.Println("请提供任务内容")
return
}
fmt.Printf("已添加任务: %s\n", args[0])
},
}
func init() {
rootCmd.AddCommand(addCmd)
}
运行效果:
-
go run main.go add "学习 Go"→ 输出“已添加任务: 学习 Go” -
go run main.go --help→ 显示自动帮助
增强 CLI 功能
实际项目中,CLI 工具常需以下能力:
- 配置文件支持:用 viper 集成 JSON/YAML 配置
- 持久化数据:将任务存入本地文件或 SQLite
- 用户交互:使用 survey 等库实现选择、确认对话
- 自动补全:cobra 可生成 shell 补全脚本
- 日志输出:集成 zap 或 log 打印调试信息
在命令中定义 Flags:
var verbose bool addCmd.Flags().BoolVarP(&verbose, "verbose", "v", false, "启用详细输出")
这样可通过 -v 控制日志级别。










