Cobra で --help の説明文を変える方法

2024-05-26

--help の説明文はデフォルトで `help for コマンド名` だが、この文章を変えるには。

・単に help フラグを定義してあげればいい
・他にも方法はあると思う

コード

</>

package main

import (
	"fmt"

	"github.com/spf13/cobra"
)

func main() {
	app := &cobra.Command{
		Use:     "sample",
		Version: "0.0.1",
		Run: func(cmd *cobra.Command, args []string) {
			fmt.Println("hello")
		},
	}

	// デフォルトの --help を上書き
	app.PersistentFlags().BoolP("help", "", false, "Show help information")
	app.PersistentFlags().BoolP("version", "", false, "Show version")

	app.Execute()
}

実行結果

</>

$ go run . --help
Usage:
  sample [flags]

Flags:
      --help      Show help information
      --version   Show version