Go 写命令行工具轻量高效,标准库 flag 支持基础参数解析,核心流程为“定义→解析→执行”;通过 flag.NewFlagSet 可实现子命令(如 init、build)的独立参数管理。

用 Go 写命令行工具非常轻量、高效,标准库 flag 就能完成大多数参数解析需求,无需额外依赖。核心是把逻辑拆成“参数定义 → 参数解析 → 业务执行”三步,清晰且不易出错。
用 flag 包定义和解析基础参数
Go 的 flag 包支持字符串、整数、布尔等常见类型,自动处理短选项(如 -v)、长选项(如 --verbose)和位置参数。
示例:定义一个带版本号、输出路径和是否静默的工具:
package main
import (
"flag"
"fmt"
"log"
)
func main() {
// 定义参数(变量指针 + 使用说明)
version := flag.Bool("version", false, "show version and exit")
output := flag.String("output", "result.txt", "output file path")
quiet := flag.Bool("quiet", false, "suppress non-error output")
// 解析命令行输入(必须在定义后、使用前调用)
flag.Parse()
// 处理逻辑
if *version {
fmt.Println("v1.0.0")
return
}
if !*quiet {
fmt.Printf("Writing to %s\n", *output)
}
// …… 执行主任务
}
支持子命令(类似 git add / git commit)
当功能变多时,用子命令组织更清晰。Go 标准库不直接支持嵌套 flag,但可用 flag.NewFlagSet 为每个子命令单独管理参数。
立即学习“go语言免费学习笔记(深入)”;
关键点:
- 先读取第一个非 flag 参数作为子命令名
- 用
flag.NewFlagSet创建专属解析器 - 对每个子命令分别调用
Parse,并检查Args()获取剩余参数
例如支持 tool init 和 tool build --target=prod:
func main() {
if len(os.Args) < 2 {
log.Fatal("expected subcommand")
}
cmd := os.Args[1]
args := os.Args[2:]
switch cmd {
case "init":
initCmd := flag.NewFlagSet("init", flag.ContinueOnError)
dir := initCmd.String("dir", ".", "directory to init")
if err := initCmd.Parse(args); err != nil {
log.Fatal(err)
}
fmt.Printf("Initializing in %s\n", *dir)
case "build":
buildCmd := flag.NewFlagSet("build", flag.ContinueOnError)
target := buildCmd.String("target", "dev", "build target")
if err := buildCmd.Parse(args); err != nil {
log.Fatal(err)
}
fmt.Printf("Building for %s\n", *target)
default:
log.Fatalf("unknown command: %s", cmd)
}
}
增强体验:添加帮助信息与错误提示
默认 help 提示较简陋,可通过 flag.Usage 自定义。同时注意捕获解析失败和参数缺失场景。
建议做法:
- 设置
flag.Usage输出格式化帮助(含命令说明、参数列表、示例) - 在
flag.Parse()后检查flag.NArg()判断是否缺少必需位置参数 - 对布尔标志,避免用
=true(应写-v或--verbose),否则 flag 可能误判
示例自定义 Usage:
flag.Usage = func() {
fmt.Fprintf(os.Stderr, "Usage: %s [flags] \n", os.Args[0])
fmt.Fprintf(os.Stderr, "Flags:\n")
flag.PrintDefaults()
fmt.Fprintf(os.Stderr, "\nExample:\n %s -output=out.json config.yaml\n", os.Args[0])
}
进阶可选:用第三方库简化复杂 CLI
如果需要自动补全、颜色输出、嵌套子命令、配置文件支持等功能,可考虑成熟库:
- spf13/cobra:最主流,被 kubectl、helm 等广泛采用,自带 help、bash 补全、文档生成
- alecthomas/kingpin:API 更函数式,类型安全强,适合中等复杂度工具
- urfave/cli:轻量易上手,结构清晰,适合快速原型
它们不替代 flag,而是封装了 flag 并扩展能力。初期用标准库完全够用,功能变多再平滑迁移。










