cli

Documentation

Index

• type Command
  • func (c *Command) AddCommand(newCmds ...*Command)
  • func (c *Command) Execute(args []string) error
  • func (c *Command) GenHelpText() string
  • func (c *Command) GetChildren() []*Command
  • func (c *Command) GetChildrenNames(all bool) []string
  • func (c *Command) NewFlagSet() *pflag.FlagSet
• type ValidateArgsFunc
  • func NoArgs() ValidateArgsFunc
  • func RangeArgs(min, max int) ValidateArgsFunc
  • func RequireArgs(n int) ValidateArgsFunc

Types

type Command

type Command struct {
	// Name : コマンド名
	Name string
	// Shorthand : ショートハンド
	Shorthand string
	// Short : 短いヘルプ文
	Short string
	// Long : 長いヘルプ文
	Long string
	// UsageArgs : 使い方（引数）
	UsageArgs string
	// Example : サンプル
	Example string
	// Hidden : コマンドを表示しない
	Hidden bool

	// Validate : 引数のバリデーション関数
	Validate ValidateArgsFunc
	// SetFlag : フラグの設定
	SetFlag func(f *pflag.FlagSet)
	// Run : コマンドの処理
	Run func(c *Command, f *pflag.FlagSet) error
	// Help : ヘルプ関数（オーバーライド）
	Help func(c *Command, h string)
	// contains filtered or unexported fields
}

Command : コマンド

func (*Command) AddCommand

func (c *Command) AddCommand(newCmds ...*Command)

AddCommand : コマンドを追加

func (*Command) Execute

func (c *Command) Execute(args []string) error

Execute : 実行

func (*Command) GenHelpText

func (c *Command) GenHelpText() string

GenHelpText : ヘルプ文を作成

func (*Command) GetChildren

func (c *Command) GetChildren() []*Command

GetChildren : サブコマンドを取得

func (*Command) GetChildrenNames

func (c *Command) GetChildrenNames(all bool) []string

GetChildrenNames : サブコマンド名の一覧を取得

func (*Command) NewFlagSet

func (c *Command) NewFlagSet() *pflag.FlagSet

NewFlagSet : flagsetを生成

type ValidateArgsFunc

type ValidateArgsFunc func(c *Command, args []string) error

ValidateArgsFunc : 引数のバリデーション関数

func NoArgs

func NoArgs() ValidateArgsFunc

NoArgs : 引数無し

func RangeArgs

func RangeArgs(min, max int) ValidateArgsFunc

RangeArgs : min~max個の引数をとる

func RequireArgs

func RequireArgs(n int) ValidateArgsFunc

RequireArgs : n個の引数をとる