flagx

README

flags

parse struct from command line and environments

Documentation

Index

• func Parse(strcutVal any, args []string, options ...func(flagSet *flag.FlagSet)) ([]string, error)
• func Walk(strcutVal any, walkFn func(item Flag))
• type App
  • func New(args ...string) *App
  • func (app *App) AddCommand(name string, command Command) *App
  • func (app *App) Run(ctx context.Context)
  • func (app *App) Usage()
• type Command
• type Flag
  • func Struct(strcutVal any) (flags []Flag)
  • func (v Flag) Get() any
  • func (v Flag) GetSlice() []string
  • func (v Flag) IsBoolFlag() bool
  • func (v Flag) IsZero() bool
  • func (v Flag) KindString() string
  • func (v Flag) Set(s string) error
  • func (v Flag) SetValue(x reflect.Value)
  • func (v Flag) String() string

Functions

func Parse

func Parse(strcutVal any, args []string, options ...func(flagSet *flag.FlagSet)) ([]string, error)

Parse 解析参数到struct

func Walk

func Walk(strcutVal any, walkFn func(item Flag))

Types

type App

type App struct {
	// contains filtered or unexported fields
}

func New

func New(args ...string) *App

func (*App) AddCommand

func (app *App) AddCommand(name string, command Command) *App

func (*App) Run

func (app *App) Run(ctx context.Context)

func (*App) Usage

func (app *App) Usage()

type Command

type Command interface {
	Run(ctx context.Context, args []string) error
}

type Flag

type Flag struct {
	Name        string   // 名称
	Aliases     []string // 别名
	Usage       string   // 用法说明
	EnvVars     []string // 关联环境变量
	Default     string   // 默认值字符串
	Deprecated  string   // 过期描述
	NoOptDefVal string   // 不带参数
	Required    bool     // 必须
	Hidden      bool     // 隐藏参数
	// contains filtered or unexported fields
}

func Struct

func Struct(strcutVal any) (flags []Flag)

将struct转换为参数标记集合

func (Flag) Get

func (v Flag) Get() any

func (Flag) GetSlice

func (v Flag) GetSlice() []string

func (Flag) IsBoolFlag

func (v Flag) IsBoolFlag() bool

func (Flag) IsZero

func (v Flag) IsZero() bool

func (Flag) KindString

func (v Flag) KindString() string

func (Flag) Set

func (v Flag) Set(s string) error

func (Flag) SetValue

func (v Flag) SetValue(x reflect.Value)

func (Flag) String

func (v Flag) String() string