Go 开发命令行工具轻量高效,核心是参数解析、逻辑组织与结果输出;标准库 flag 可处理基础参数,spf13/cobra 支持子命令,应提供文本 /JSON 双输出模式,并规范错误提示与退出码。

用 Go 开发命令行 工具 非常轻量高效,核心在于清晰解析参数、合理组织逻辑、友好输出结果。标准库 flag 足够应对大多数场景,配合 fmt 和结构化数据(如 JSON)即可实现专业级 CLI 工具。
使用 flag 包解析基础参数
Go 标准库的 flag 包支持字符串、数值、布尔等常见类型,自动处理 `-h`/`–help` 和类型校验。
- 定义变量时直接调用
flag.String()、flag.Int()等,返回指针,便于后续传入 - 调用
flag.Parse()解析命令行,未识别参数会存入flag.Args() - 支持短选项(
-n)和长选项(--name),用flag.StringVar(&name, "name", "default", "user name")绑定描述
支持子命令与更灵活的参数结构
当工具需要多个功能(如 git clone、git commit),推荐用第三方库 spf13/cobra,它提供子命令、自动帮助生成、参数分组等能力。
- 每个子命令对应一个
*cobra.Command实例,设置Run字段执行逻辑 - 通过
cmd.Flags().StringP("output", "o", "text", "output format: text or json")添加带别名的标志 - 根命令调用
rootCmd.Execute()启动解析,错误自动打印
统一输出格式:文本与 JSON 双模式
面向开发者或集成场景的 CLI 应支持结构化输出(如 JSON),同时保留可读文本,默认以文本为主,用 --json 切换。
立即学习“go 语言免费学习笔记(深入)”;
- 定义输出结构体,例如
type Result {Name string `json:"name"` Count int `json:"count"`} - 判断
flag.Output == "json",则用json.NewEncoder(os.Stdout).Encode(result) - 否则用
fmt.Printf("Name: %s, Count: %dn", result.Name, result.Count)输出易读文本
错误处理与用户提示要明确
CLI 的体验关键在错误是否及时、提示是否具体。避免 panic,优先返回错误并退出非零 状态码。
- 解析失败(如类型错误)由
flag自动处理并打印 usage;自定义校验失败时调用fmt.Fprintln(os.Stderr, "error: ……") - 业务错误后调用
os.Exit(1),成功为os.Exit(0) - 必要时在 help 中补充示例,如
Usage: mytool fetch --id 123