CLI 工具 flag 与 cobra

package main

import (
	"fmt"
	"os"
)

func main() {
	fmt.Println("程序名:", os.Args[0]) // ./app
	fmt.Println("参数个数:", len(os.Args)-1)
	for i, a := range os.Args[1:] {
		fmt.Printf("参数%d: %s\n", i, a)
	}
}

go build -o app main.go
./app foo bar
# 程序名: ./app
# 参数个数: 2
# 参数0: foo
# 参数1: bar

package main

import (
	"flag"
	"fmt"
)

func main() {
	// 返回的都是 *string / *int / *bool
	name := flag.String("name", "world", "要问候的名字")       // -name x  / --name x
	count := flag.Int("count", 1, "重复次数")                  // -count 3
	verbose := flag.Bool("verbose", false, "是否输出详细信息")  // -verbose（布尔无需值）

	flag.Parse() // 关键：解析动作在这一步

	for i := 0; i < *count; i++ {
		if *verbose {
			fmt.Printf("#%d ", i+1)
		}
		fmt.Printf("Hello, %s!\n", *name)
	}

	// 位置参数（非 flag 的剩余参数）在 flag.Args() 里
	fmt.Println("位置参数:", flag.Args())
}

go run main.go -name Tom -count 2 -verbose
# #1 Hello, Tom!
# #2 Hello, Tom!
# 位置参数: []

go run main.go Tom
# Hello, world!
# 位置参数: [Tom]

go run main.go -h
# 输出自动生成的 Usage：
#   -count int
#         重复次数 (default 1)
#   -name string
#         要问候的名字 (default "world")
#   -verbose
#         是否输出详细信息

package main

import (
	"flag"
	"fmt"
	"os"
)

func main() {
	// 解析出第一个非 flag 参数，当作子命令名
	args := os.Args[1:]
	if len(args) < 1 {
		usage()
		os.Exit(1)
	}

	switch args[0] {
	case "add":
		runAdd(args[1:])
	case "list":
		runList(args[1:])
	default:
		usage()
		os.Exit(1)
	}
}

func usage() {
	fmt.Println("用法: todolist <add|list> [选项]")
}

func runAdd(args []string) {
	fs := flag.NewFlagSet("add", flag.ExitOnError)
	title := fs.String("title", "", "任务标题")
	fs.Parse(args)
	fmt.Printf("添加任务: %q\n", *title)
}

func runList(args []string) {
	fs := flag.NewFlagSet("list", flag.ExitOnError)
	all := fs.Bool("all", false, "显示全部含已完成")
	fs.Parse(args)
	fmt.Printf("列出任务 (all=%v)\n", *all)
}

go run main.go add -title "学 Go"
# 添加任务: "学 Go"
go run main.go list -all
# 列出任务 (all=true)

go get github.com/spf13/cobra@latest

package main

import (
	"fmt"
	"os"

	"github.com/spf13/cobra"
)

// 全局 flag 变量（cobra 不返回指针，而是绑定到变量）
var (
	verbose bool
	name    string
)

// 1. 根命令：程序对外暴露的名字是 app
var rootCmd = &cobra.Command{
	Use:   "app",
	Short: "一个示例 CLI",
	Long:  "app 是一个用来演示 cobra 的示例命令，包含根命令和子命令。",
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Printf("你好，%s（verbose=%v）\n", name, verbose)
	},
}

// 2. 子命令 greet：要求恰好 1 个位置参数
var greetCmd = &cobra.Command{
	Use:   "greet <名字>",
	Short: "向某人问好",
	Args:  cobra.ExactArgs(1), // 参数数量校验，不满足会报错
	Run: func(cmd *cobra.Command, args []string) {
		names := args[0]
		if verbose {
			fmt.Printf("[verbose] 开始打招呼...\n")
		}
		fmt.Printf("你好，%s！\n", names)
	},
}

func init() {
	// PersistentFlags：该 flag 对其自身和所有子命令都生效
	rootCmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "verbose 输出")
	// Flags：只对当前命令生效
	rootCmd.Flags().StringVar(&name, "name", "world", "要问候的名字")

	// 把子命令挂到根命令上
	rootCmd.AddCommand(greetCmd)
}

func main() {
	if err := rootCmd.Execute(); err != nil {
		fmt.Fprintln(os.Stderr, err)
		os.Exit(1)
	}
}

go run . -name Alice
# 你好，Alice（verbose=false）

go run . greet 小明 -v
# [verbose] 开始打招呼...
# 你好，小明！

go run . greet            # 参数不足
# Error: accepts 1 arg(s), received 0

mycli/
├── main.go              # 只做一件事：调 cmd.Execute()
├── go.mod
├── cmd/                 # 命令定义区
│   ├── root.go          # 根命令 + 全局 flag
│   ├── add.go           # add 子命令
│   └── list.go          # list 子命令
└── internal/            # 业务实现（不对外导出）
    └── todo/
        └── todo.go      # todo 的具体逻辑

// main.go —— 入口只留 execute
package main

import "mycli/cmd"

func main() {
	cmd.Execute()
}

// cmd/root.go —— 根命令定义 Execute 符号
package cmd

import (
	"os"

	"github.com/spf13/cobra"
)

var rootCmd = &cobra.Command{
	Use:   "mycli",
	Short: "一个多子命令 CLI 工具",
}

func Execute() {
	if err := rootCmd.Execute(); err != nil {
		os.Exit(1)
	}
}

func init() {
	// 注意这里把子命令注册集中到 root.go，或分散在各 *_test.go 旁
	rootCmd.AddCommand(addCmd, listCmd)
}

// cmd/add.go —— 每个子命令一个文件
package cmd

import (
	"fmt"

	"github.com/spf13/cobra"
)

var addCmd = &cobra.Command{
	Use:   "add <标题>",
	Short: "添加一条待办",
	Args:  cobra.ExactArgs(1),
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Printf("添加待办: %s\n", args[0])
	},
}

// cmd/root.go 里追加
func init() {
	rootCmd.AddCommand(completionCmd)
}

var completionCmd = &cobra.Command{
	Use:   "completion [bash|zsh|fish]",
	Short: "生成 shell 补全脚本",
	Args:  cobra.ExactValidArgs(1),
	Run: func(cmd *cobra.Command, args []string) {
		switch args[0] {
		case "bash":
			rootCmd.GenBashCompletion(os.Stdout)
		case "zsh":
			rootCmd.GenZshCompletion(os.Stdout)
		case "fish":
			rootCmd.GenFishCompletion(os.Stdout, true)
		}
	},
}

go build -o mycli .
./mycli completion bash > /etc/bash_completion.d/mycli  # 安装补全
./mycli help          # 查看帮助
./mycli greet --help  # 查看子命令帮助