xflags

Jan 26, 2022

Changes in this version

type ArgumentError

+ Err error

+ Text string

+ func (e *ArgumentError) String() string

+ func (e *ArgumentError) Unwrap() error

type Command

+ Stderr io.Writer

+ Stdout io.Writer

type FlagBuilder

+ func (c *FlagBuilder) Choices(elems ...string) *FlagBuilder

Dec 29, 2021

Changes in this version

+ func Format(w io.Writer, cmd *Command) error

type Command

+ FormatFunc FormatFunc

+ Output io.Writer

+ func (c *Command) Arg(i int) string

type CommandBuilder

+ func (c *CommandBuilder) FormatFunc(fn FormatFunc) *CommandBuilder

+ func (c *CommandBuilder) Output(w io.Writer) *CommandBuilder

type FlagBuilder

+ func BitField(p *uint64, mask uint64, name string, value bool, usage string) *FlagBuilder

+ func Func(name, usage string, fn func(s string) error) *FlagBuilder

+ func Int(p *int, name string, value int, usage string) *FlagBuilder

+ func Strings(p *[]string, name string, value []string, usage string) *FlagBuilder

+ func Uint(p *uint, name string, value uint, usage string) *FlagBuilder

+ func Uint64(p *uint64, name string, value uint64, usage string) *FlagBuilder

+ type FormatFunc func(w io.Writer, cmd *Command) error

Dec 28, 2021

Changes in this version

+ func RunWithArgs(cmd Commander, args ...string) int

type Command

+ FlagGroups []*FlagGroup

+ Formatter Formatter

+ HandlerFunc HandlerFunc

+ Hidden bool

+ Name string

+ Parent *Command

+ Subcommands []*Command

+ Synopsis string

+ Usage string

+ WithTerminator bool

+ func (c *Command) Args() []string

+ func (c *Command) Command() (*Command, error)

+ func (c *Command) Err() error

+ func (c *Command) Parse(args []string) (*Command, error)

+ func (c *Command) Run(args []string) int

+ func (c *Command) String() string

+ func (c *Command) WriteUsage(w io.Writer) error

type CommandBuilder

+ func NewCommand(name, usage string) *CommandBuilder

+ func (c *CommandBuilder) Command() (*Command, error)

+ func (c *CommandBuilder) HandleFunc(handler func(args []string) int) *CommandBuilder

+ type Commander interface

+ Command func() (*Command, error)

+ type Flag struct

+ EnvVar string

+ Hidden bool

+ MaxCount int

+ MinCount int

+ Name string

+ Positional bool

+ ShortName string

+ ShowDefault bool

+ Usage string

+ Validate ValidateFunc

+ Value Value

+ func (c *Flag) Err() error

+ func (c *Flag) Flag() (*Flag, error)

+ func (c *Flag) Set(s string) error

+ func (c *Flag) String() string

type FlagBuilder

+ func (c *FlagBuilder) Flag() (*Flag, error)

+ type FlagGroup struct

+ Flags []*Flag

+ Name string

+ Usage string

+ type Flagger interface

+ Flag func() (*Flag, error)

+ type HandlerFunc func(args []string) int

Nov 11, 2021

Changes in this version

+ type ArgumentError struct

+ Arg string

+ Cmd *CommandInfo

+ Flag *FlagInfo

+ Msg string

+ func (err *ArgumentError) Error() string

type CommandBuilder

+ func (c *CommandBuilder) Synopsis(s string) *CommandBuilder

type FlagInfo

+ func (c *FlagInfo) Set(s string) error

+ type HelpError struct

+ Cmd *CommandInfo

+ func (err *HelpError) Error() string

Oct 17, 2021

Changes in this version

type FlagBuilder

+ func (c *FlagBuilder) Validate(f ValidateFunc) *FlagBuilder

type FlagInfo

+ Validate ValidateFunc

+ type ValidateFunc = func(arg string) error

Oct 16, 2021

Changes in this version

type FlagBuilder

+ func IntVar(p *int, name string, value int, usage string) *FlagBuilder

+ func Uint64Var(p *uint64, name string, value uint64, usage string) *FlagBuilder

+ func UintVar(p *uint, name string, value uint, usage string) *FlagBuilder

Oct 16, 2021

Changes in this version

type CommandBuilder

+ func (c *CommandBuilder) FlagGroup(name, usage string, flags ...*FlagInfo) *CommandBuilder

type CommandInfo

+ FlagGroups []*FlagGroupInfo

+ type FlagGroupInfo struct

+ Flags []*FlagInfo

+ Name string

+ Usage string

Oct 16, 2021

Changes in this version

+ type BoolValue interface

+ IsBoolFlag func() bool

type CommandBuilder

+ func (c *CommandBuilder) FlagSet(flagSet *flag.FlagSet) *CommandBuilder

+ func (c *CommandBuilder) Must() *CommandInfo

+ func (c *CommandBuilder) WithTerminator() *CommandBuilder

type CommandInfo

+ WithTerminator bool

+ func (c *CommandInfo) Args() []string

type FlagBuilder

+ func BitFieldVar(p *uint64, mask uint64, name string, value bool, usage string) *FlagBuilder

+ func BoolVar(p *bool, name string, value bool, usage string) *FlagBuilder

+ func DurationVar(p *time.Duration, name string, value time.Duration, usage string) *FlagBuilder

+ func Float64Var(p *float64, name string, value float64, usage string) *FlagBuilder

+ func Int64Var(p *int64, name string, value int64, usage string) *FlagBuilder

+ func StringSliceVar(p *[]string, name string, value []string, usage string) *FlagBuilder

+ func StringVar(p *string, name, value, usage string) *FlagBuilder

+ func (c *FlagBuilder) Env(name string) *FlagBuilder

+ func (c *FlagBuilder) Must() *FlagInfo

+ func (c *FlagBuilder) ShowDefault() *FlagBuilder

type FlagInfo

+ ShowDefault bool

type Value

+ String func() string

Oct 15, 2021

Changes in this version

+ type CommandFunc func(args []string) int

Oct 7, 2021

Changes in this version

type FlagBuilder

+ func (c *FlagBuilder) EnvVar(name string) *FlagBuilder

type FlagInfo

+ EnvVar string

+ type ValueFunc func(s string) error

+ func (f ValueFunc) Reset()

+ func (f ValueFunc) Set(s string) error

Oct 7, 2021

Changes in this version

+ func DefaultFormatter(w io.Writer, info *CommandInfo) error

+ func Run(cmd *CommandInfo) int

+ type CommandBuilder struct

+ func Command(name string) *CommandBuilder

+ func (c *CommandBuilder) Build() (*CommandInfo, error)

+ func (c *CommandBuilder) Flags(flags ...*FlagInfo) *CommandBuilder

+ func (c *CommandBuilder) Formatter(formatter Formatter) *CommandBuilder

+ func (c *CommandBuilder) Handler(handler CommandHandler) *CommandBuilder

+ func (c *CommandBuilder) Hidden() *CommandBuilder

+ func (c *CommandBuilder) MustBuild() *CommandInfo

+ func (c *CommandBuilder) Subcommands(commands ...*CommandInfo) *CommandBuilder

+ func (c *CommandBuilder) Usage(usage string) *CommandBuilder

+ type CommandHandler func() int

+ type CommandInfo struct

+ Flags []*FlagInfo

+ Formatter Formatter

+ Handler CommandHandler

+ Hidden bool

+ Name string

+ Parent *CommandInfo

+ Subcommands []*CommandInfo

+ Synopsis string

+ Usage string

+ func (c *CommandInfo) Parse(args []string) (CommandHandler, error)

+ func (c *CommandInfo) Run(args []string) int

+ func (c *CommandInfo) String() string

+ func (c *CommandInfo) WriteUsage(w io.Writer) error

+ type FlagBuilder struct

+ func Bool(p *bool, name string) *FlagBuilder

+ func Duration(p *time.Duration, name string) *FlagBuilder

+ func Float64(p *float64, name string) *FlagBuilder

+ func Int64(p *int64, name string) *FlagBuilder

+ func String(p *string, name string) *FlagBuilder

+ func StringSlice(p *[]string, name string) *FlagBuilder

+ func Var(value Value, name string) *FlagBuilder

+ func (c *FlagBuilder) Boolean() *FlagBuilder

+ func (c *FlagBuilder) Build() (*FlagInfo, error)

+ func (c *FlagBuilder) Hidden() *FlagBuilder

+ func (c *FlagBuilder) MustBuild() *FlagInfo

+ func (c *FlagBuilder) NArgs(min, max int) *FlagBuilder

+ func (c *FlagBuilder) Positional() *FlagBuilder

+ func (c *FlagBuilder) Required() *FlagBuilder

+ func (c *FlagBuilder) ShortName(name string) *FlagBuilder

+ func (c *FlagBuilder) Usage(usage string) *FlagBuilder

+ type FlagInfo struct

+ Boolean bool

+ Hidden bool

+ MaxCount int

+ MinCount int

+ Name string

+ Positional bool

+ ShortName string

+ Usage string

+ Value Value

+ func (c *FlagInfo) String() string

+ type Formatter func(w io.Writer, info *CommandInfo) error

+ type Value interface

+ Reset func()

+ Set func(s string) error