gflag

package

Go to main page

Versions in this module

v3

v3.3.0

Dec 24, 2025

Changes in this version

+ const FlagTypeBool

+ const FlagTypeDur

+ const FlagTypeFloat

+ const FlagTypeFunc

+ const FlagTypeInt

+ const FlagTypeString

+ const FlagTypeVar

type CliOpt

+ Collector func() (string, error)

+ Handler func(val string) error

+ func (m *CliOpt) Value() Value

type CliOptFn

+ func WithCollector(fn func() (string, error)) CliOptFn

+ func WithHandler(fn func(val string) error) CliOptFn

type CliOpts

+ func (co *CliOpts) DurationOpt(ptr *time.Duration, name, shorts string, defVal time.Duration, desc string, ...)

+ func (co *CliOpts) DurationOpt2(ptr *time.Duration, nameAndShorts, desc string, setFns ...CliOptFn)

+ func (co *CliOpts) DurationVar(ptr *time.Duration, opt *CliOpt)

+ func (co *CliOpts) StringOpt(p *string, name, shorts string, defValAndDesc ...string)

+ func (co *CliOpts) StringOpt2(p *string, nameAndShorts, desc string, setFns ...CliOptFn)

+ func (co *CliOpts) StringVar(p *string, opt *CliOpt)

v3.2.4

Dec 12, 2024

Changes in this version

+ func UnquoteUsage(flag *Flag) (name string, usage string)

type CliOpts

+ func (co *CliOpts) FSet() *FlagSet

+ func (co *CliOpts) FuncOpt(nameAndShorts, desc string, fn FuncOptFn, setFns ...CliOptFn)

+ func (co *CliOpts) ParseOpts(args []string) (err error)

+ func (co *CliOpts) SetFlagSet(fSet *FlagSet)

type Config

+ EnhanceShort uint8

+ type Flag = flag.Flag

+ type FlagSet struct

+ Usage func()

+ func NewFlagSet(name string, errorHandling flag.ErrorHandling) *FlagSet

+ func (f *FlagSet) Arg(i int) string

+ func (f *FlagSet) Args() []string

+ func (f *FlagSet) Bool(name string, value bool, usage string) *bool

+ func (f *FlagSet) BoolVar(p *bool, name string, value bool, usage string) *Flag

+ func (f *FlagSet) Duration(name string, value time.Duration, usage string) *time.Duration

+ func (f *FlagSet) DurationVar(p *time.Duration, name string, value time.Duration, usage string) *Flag

+ func (f *FlagSet) Float64(name string, value float64, usage string) *float64

+ func (f *FlagSet) Float64Var(p *float64, name string, value float64, usage string) *Flag

+ func (f *FlagSet) Func(name, usage string, fn func(string) error) *Flag

+ func (f *FlagSet) Int(name string, value int, usage string) *int

+ func (f *FlagSet) Int64(name string, value int64, usage string) *int64

+ func (f *FlagSet) Int64Var(p *int64, name string, value int64, usage string) *Flag

+ func (f *FlagSet) IntVar(p *int, name string, value int, usage string) *Flag

+ func (f *FlagSet) Lookup(name string) *Flag

+ func (f *FlagSet) NFlag() int

+ func (f *FlagSet) Parse(arguments []string) error

+ func (f *FlagSet) Parsed() bool

+ func (f *FlagSet) Set(name, value string) error

+ func (f *FlagSet) String(name, value, usage string) *string

+ func (f *FlagSet) StringVar(p *string, name, value, usage string) *Flag

+ func (f *FlagSet) TextVar(p encoding.TextUnmarshaler, name string, value encoding.TextMarshaler, ...) *Flag

+ func (f *FlagSet) Uint(name string, value uint, usage string) *uint

+ func (f *FlagSet) Uint64(name string, value uint64, usage string) *uint64

+ func (f *FlagSet) Uint64Var(p *uint64, name string, value uint64, usage string) *Flag

+ func (f *FlagSet) UintVar(p *uint, name string, value uint, usage string) *Flag

+ func (f *FlagSet) Var(value Value, name string, usage string) *Flag

+ func (f *FlagSet) VisitAll(fn func(*Flag))

type Flags

+ AfterParse func(fs *Flags) error

+ Desc string

+ HandleFunc HandleFunc

+ type FuncOptFn func(string) error

+ type ValidValue struct

+ Validator func(val string) error

+ func (v *ValidValue) Set(s string) error

+ type Value = flag.Value

v3.2.3

Jul 27, 2023

v3.2.2

Jun 25, 2023

Changes in this version

+ const TagRuleField

type CliArg

+ func (a *CliArg) WithArrayed() *CliArg

type CliOpts

+ func (ops *CliOpts) VarOpt2(v flag.Value, nameAndShorts, desc string, setFns ...CliOptFn)

type Config

+ IndentLongOpt bool

+ func (c *Config) GetTagName() string

+ type ConfigFunc func(cfg *Config)

+ func WithIndentLongOpt(yes bool) ConfigFunc

+ type IntsString = cflag.IntsString

type Parser

+ func (p *Parser) MustFromStruct(ptr any, ruleType ...uint8)

+ func (p *Parser) ParserCfg() *Config

+ func (p *Parser) SetRuleType(rt uint8) *Parser

+ type String = cflag.String

v3.2.1

Feb 26, 2023

Changes in this version

type CliArg

+ AfterFn func(a *CliArg) error

+ func (a *CliArg) WithAfterFn(fn func(a *CliArg) error) *CliArg

+ type ConfString = cflag.ConfString

+ type KVString = cflag.KVString

v3.2.0

Feb 11, 2023

Changes in this version

+ var DefaultOptWidth = 20

type CliArg

+ func (a *CliArg) WithDefault(val any) *CliArg

type CliArgs

+ func (ags *CliArgs) ExtraArgs() []string

type CliOpt

+ func NewOpt(nameAndShorts, desc string, defVal any, setFns ...CliOptFn) *CliOpt

+ func (m *CliOpt) ShortsString(sep ...string) string

+ func (m *CliOpt) WithOptFns(fns ...CliOptFn) *CliOpt

+ type CliOptFn func(opt *CliOpt)

+ func WithDefault(defVal any) CliOptFn

+ func WithRequired() CliOptFn

+ func WithShortcut(shortcut string) CliOptFn

+ func WithShorts(shorts ...string) CliOptFn

+ func WithValidator(fn func(val string) error) CliOptFn

type CliOpts

+ func (ops *CliOpts) BoolOpt2(p *bool, nameAndShorts, desc string, setFns ...CliOptFn)

+ func (ops *CliOpts) IntOpt2(p *int, nameAndShorts, desc string, setFns ...CliOptFn)

+ func (ops *CliOpts) StrOpt2(p *string, nameAndShorts, desc string, setFns ...CliOptFn)

v3.1.1

Dec 22, 2022

v3.1.0

Oct 16, 2022

Changes in this version

+ const AlignLeft

+ const AlignRight

+ const TagRuleNamed

+ const TagRuleSimple

+ var FlagTagName = "flag"

+ func ParseSimpleRule(name, rule string) (mp map[string]string)

+ type Argument = CliArg

+ type Arguments = CliArgs

+ type Booleans = cflag.Booleans

+ type CliArg struct

+ Arrayed bool

+ Desc string

+ Handler func(val any) any

+ Name string

+ Required bool

+ ShowName string

+ Validator func(val any) (any, error)

+ func NewArg(name, desc string, val any, requiredAndArrayed ...bool) *CliArg

+ func NewArgument(name, desc string, requiredAndArrayed ...bool) *CliArg

+ func (a *CliArg) Array() (ss []string)

+ func (a *CliArg) GetValue() any

+ func (a *CliArg) HasValue() bool

+ func (a *CliArg) HelpName() string

+ func (a *CliArg) Index() int

+ func (a *CliArg) Init() *CliArg

+ func (a *CliArg) SetArrayed() *CliArg

+ func (a *CliArg) SetValue(val any) error

+ func (a *CliArg) WithFn(fn func(arg *CliArg)) *CliArg

+ func (a *CliArg) WithValidator(fn func(any) (any, error)) *CliArg

+ func (a *CliArg) WithValue(val any) *CliArg

+ type CliArgs struct

+ func (ags *CliArgs) AddArg(name, desc string, requiredAndArrayed ...bool) *CliArg

+ func (ags *CliArgs) AddArgByRule(name, rule string) *CliArg

+ func (ags *CliArgs) AddArgument(arg *CliArg) *CliArg

+ func (ags *CliArgs) Arg(name string) *CliArg

+ func (ags *CliArgs) ArgByIndex(i int) *CliArg

+ func (ags *CliArgs) Args() []*CliArg

+ func (ags *CliArgs) BindArg(arg *CliArg) *CliArg

+ func (ags *CliArgs) BuildArgsHelp() string

+ func (ags *CliArgs) HasArg(name string) bool

+ func (ags *CliArgs) HasArgs() bool

+ func (ags *CliArgs) HasArguments() bool

+ func (ags *CliArgs) ParseArgs(args []string) (err error)

+ func (ags *CliArgs) SetName(name string)

+ func (ags *CliArgs) SetValidateNum(validateNum bool)

+ func (ags *CliArgs) String() string

+ type CliOpt struct

+ DefVal any

+ Desc string

+ EnvVar string

+ Hidden bool

+ Name string

+ Question string

+ Required bool

+ Shorts []string

+ Validator func(val string) error

+ func (m *CliOpt) DValue() *stdutil.Value

+ func (m *CliOpt) Flag() *flag.Flag

+ func (m *CliOpt) HelpName() string

+ func (m *CliOpt) Shorts2String(sep ...string) string

+ func (m *CliOpt) Validate(val string) error

+ type CliOpts struct

+ func (ops *CliOpts) Bool(name, shorts string, defVal bool, desc string) *bool

+ func (ops *CliOpts) BoolOpt(ptr *bool, name, shorts string, defVal bool, desc string)

+ func (ops *CliOpts) BoolVar(ptr *bool, opt *CliOpt)

+ func (ops *CliOpts) Float64Opt(p *float64, name, shorts string, defVal float64, desc string)

+ func (ops *CliOpts) Float64Var(ptr *float64, opt *CliOpt)

+ func (ops *CliOpts) HasOption(name string) bool

+ func (ops *CliOpts) InitFlagSet(name string)

+ func (ops *CliOpts) Int(name, shorts string, defVal int, desc string) *int

+ func (ops *CliOpts) Int64(name, shorts string, defVal int64, desc string) *int64

+ func (ops *CliOpts) Int64Opt(ptr *int64, name, shorts string, defValue int64, desc string)

+ func (ops *CliOpts) Int64Var(ptr *int64, opt *CliOpt)

+ func (ops *CliOpts) IntOpt(ptr *int, name, shorts string, defVal int, desc string)

+ func (ops *CliOpts) IntVar(ptr *int, opt *CliOpt)

+ func (ops *CliOpts) IsOption(name string) bool

+ func (ops *CliOpts) IsShortName(short string) bool

+ func (ops *CliOpts) IsShortOpt(short string) bool

+ func (ops *CliOpts) IterAll(fn func(f *flag.Flag, opt *CliOpt))

+ func (ops *CliOpts) LookupFlag(name string) *flag.Flag

+ func (ops *CliOpts) Opt(name string) *CliOpt

+ func (ops *CliOpts) Opts() map[string]*CliOpt

+ func (ops *CliOpts) SetName(name string)

+ func (ops *CliOpts) ShortNames(name string) (ss []string)

+ func (ops *CliOpts) Str(name, shorts string, defVal, desc string) *string

+ func (ops *CliOpts) StrOpt(p *string, name, shorts string, defValWithDesc ...string)

+ func (ops *CliOpts) StrVar(p *string, opt *CliOpt)

+ func (ops *CliOpts) Uint(name, shorts string, defVal uint, desc string) *uint

+ func (ops *CliOpts) Uint64(name, shorts string, defVal uint64, desc string) *uint64

+ func (ops *CliOpts) Uint64Opt(ptr *uint64, name, shorts string, defVal uint64, desc string)

+ func (ops *CliOpts) Uint64Var(ptr *uint64, opt *CliOpt)

+ func (ops *CliOpts) UintOpt(ptr *uint, name, shorts string, defValue uint, desc string)

+ func (ops *CliOpts) UintVar(ptr *uint, opt *CliOpt)

+ func (ops *CliOpts) Var(ptr flag.Value, opt *CliOpt)

+ func (ops *CliOpts) VarOpt(v flag.Value, name, shorts, desc string)

+ type Config struct

+ Alignment uint8

+ DescNewline bool

+ DisableArg bool

+ TagName string

+ TagRuleType uint8

+ WithoutType bool

+ type EnumString = cflag.EnumString

+ type Flags = Parser

+ type HandleFunc func(p *Parser) error

+ type Ints = cflag.Ints

+ type OptCategory struct

+ Name string

+ OptNames []string

+ Title string

+ type Parser struct

+ AfterParse func(fs *Parser) error

+ Desc string

+ func New(nameWithDesc ...string) *Parser

+ func (p *Parser) BuildHelp() string

+ func (p *Parser) BuildOptsHelp() string

+ func (p *Parser) FSet() *flag.FlagSet

+ func (p *Parser) FSetArgs() []string

+ func (p *Parser) FlagNames() map[string]int

+ func (p *Parser) FromStruct(ptr any) error

+ func (p *Parser) Init(name string)

+ func (p *Parser) Len() int

+ func (p *Parser) Name() string

+ func (p *Parser) Parse(args []string) (err error)

+ func (p *Parser) PrintHelpPanel()

+ func (p *Parser) RawArg(i int) string

+ func (p *Parser) RawArgs() []string

+ func (p *Parser) Required(names ...string)

+ func (p *Parser) Run(args []string)

+ func (p *Parser) SetConfig(opt *Config)

+ func (p *Parser) SetFlagSet(fSet *flag.FlagSet)

+ func (p *Parser) SetHandle(fn HandleFunc) *Parser

+ func (p *Parser) SetHelpRender(fn func())

+ func (p *Parser) SetName(name string)

+ func (p *Parser) SetOutput(out io.Writer)

+ func (p *Parser) String() string

+ func (p *Parser) UseSimpleRule() *Parser

+ func (p *Parser) WithConfigFn(fns ...func(cfg *Config)) *Parser

+ type Strings = cflag.Strings

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL