flaggy

package module

Go to main page

Versions in this module

v1

v1.8.0

Oct 4, 2025

Changes in this version

+ func GenerateFishCompletion(p *Parser) string

+ func GenerateNushellCompletion(p *Parser) string

+ func GeneratePowerShellCompletion(p *Parser) string

v1.7.1

Sep 20, 2025

v1.7.0

Sep 20, 2025

Changes in this version

type Help

+ GlobalFlags []HelpFlag

+ Lines []string

type HelpFlag

+ LongDisplay string

+ ShortDisplay string

v1.6.0

Sep 16, 2025

retracted

Changes in this version

+ func BigInt(assignmentVar *big.Int, shortName string, longName string, description string)

+ func BigRat(assignmentVar *big.Rat, shortName string, longName string, description string)

+ func BytesBase64(assignmentVar *Base64Bytes, shortName string, longName string, ...)

+ func DisableCompletion()

+ func EnableCompletion()

+ func FileMode(assignmentVar *os.FileMode, shortName string, longName string, ...)

+ func GenerateBashCompletion(p *Parser) string

+ func GenerateZshCompletion(p *Parser) string

+ func IPNet(assignmentVar *net.IPNet, shortName string, longName string, ...)

+ func Location(assignmentVar *time.Location, shortName string, longName string, ...)

+ func Month(assignmentVar *time.Month, shortName string, longName string, ...)

+ func NetipAddr(assignmentVar *netip.Addr, shortName string, longName string, ...)

+ func NetipAddrPort(assignmentVar *netip.AddrPort, shortName string, longName string, ...)

+ func NetipPrefix(assignmentVar *netip.Prefix, shortName string, longName string, ...)

+ func Regexp(assignmentVar *regexp.Regexp, shortName string, longName string, ...)

+ func SortFlagsByLongName()

+ func SortFlagsByLongNameReversed()

+ func TCPAddr(assignmentVar *net.TCPAddr, shortName string, longName string, ...)

+ func Time(assignmentVar *time.Time, shortName string, longName string, ...)

+ func UDPAddr(assignmentVar *net.UDPAddr, shortName string, longName string, ...)

+ func URL(assignmentVar *url.URL, shortName string, longName string, description string)

+ func Weekday(assignmentVar *time.Weekday, shortName string, longName string, ...)

+ type Base64Bytes []byte

type Help

+ ShowCompletion bool

type Parser

+ ShowCompletion bool

+ SortFlags bool

+ SortFlagsReverse bool

+ func (p *Parser) Completion(completionType string)

+ func (p *Parser) SortFlagsByLongName()

+ func (p *Parser) SortFlagsByLongNameReversed()

type Subcommand

+ func (sc *Subcommand) BigInt(assignmentVar *big.Int, shortName string, longName string, description string)

+ func (sc *Subcommand) BigRat(assignmentVar *big.Rat, shortName string, longName string, description string)

+ func (sc *Subcommand) BytesBase64(assignmentVar *Base64Bytes, shortName string, longName string, ...)

+ func (sc *Subcommand) FileMode(assignmentVar *os.FileMode, shortName string, longName string, ...)

+ func (sc *Subcommand) IPNet(assignmentVar *net.IPNet, shortName string, longName string, ...)

+ func (sc *Subcommand) Location(assignmentVar *time.Location, shortName string, longName string, ...)

+ func (sc *Subcommand) Month(assignmentVar *time.Month, shortName string, longName string, ...)

+ func (sc *Subcommand) NetipAddr(assignmentVar *netip.Addr, shortName string, longName string, ...)

+ func (sc *Subcommand) NetipAddrPort(assignmentVar *netip.AddrPort, shortName string, longName string, ...)

+ func (sc *Subcommand) NetipPrefix(assignmentVar *netip.Prefix, shortName string, longName string, ...)

+ func (sc *Subcommand) Regexp(assignmentVar *regexp.Regexp, shortName string, longName string, ...)

+ func (sc *Subcommand) TCPAddr(assignmentVar *net.TCPAddr, shortName string, longName string, ...)

+ func (sc *Subcommand) Time(assignmentVar *time.Time, shortName string, longName string, ...)

+ func (sc *Subcommand) UDPAddr(assignmentVar *net.UDPAddr, shortName string, longName string, ...)

+ func (sc *Subcommand) URL(assignmentVar *url.URL, shortName string, longName string, description string)

+ func (sc *Subcommand) Weekday(assignmentVar *time.Weekday, shortName string, longName string, ...)

v1.5.2

May 28, 2022

v1.5.1

Apr 25, 2022

Changes in this version

type Parser

+ func (p *Parser) TrailingSubcommand() *Subcommand

v1.5.0

Apr 23, 2022

v1.4.4

Feb 17, 2020

v1.4.0

Nov 15, 2019

Changes in this version

+ func ShowHelpOnUnexpectedDisable()

+ func ShowHelpOnUnexpectedEnable()

type Subcommand

+ ParsedValues []parsedValue

v1.3.0

Oct 28, 2019

Changes in this version

type HelpFlag

+ Spacer string

type HelpPositional

+ Spacer string

type HelpSubcommand

+ Spacer string

v1.2.2

Aug 21, 2019

v1.2.1

Aug 21, 2019

v1.2.0

Feb 20, 2019

Changes in this version

+ var DebugMode bool

+ var DefaultHelpTemplate = defaultHelpTemplate

+ var PanicInsteadOfExit bool

+ var TrailingArguments []string

+ func AddPositionalValue(assignmentVar *string, name string, relativePosition int, required bool, ...)

+ func AttachSubcommand(subcommand *Subcommand, relativePosition int)

+ func Bool(assignmentVar *bool, shortName string, longName string, description string)

+ func BoolSlice(assignmentVar *[]bool, shortName string, longName string, description string)

+ func ByteSlice(assignmentVar *[]byte, shortName string, longName string, description string)

+ func Duration(assignmentVar *time.Duration, shortName string, longName string, ...)

+ func DurationSlice(assignmentVar *[]time.Duration, shortName string, longName string, ...)

+ func Float32(assignmentVar *float32, shortName string, longName string, description string)

+ func Float32Slice(assignmentVar *[]float32, shortName string, longName string, ...)

+ func Float64(assignmentVar *float64, shortName string, longName string, description string)

+ func Float64Slice(assignmentVar *[]float64, shortName string, longName string, ...)

+ func HardwareAddr(assignmentVar *net.HardwareAddr, shortName string, longName string, ...)

+ func HardwareAddrSlice(assignmentVar *[]net.HardwareAddr, shortName string, longName string, ...)

+ func IP(assignmentVar *net.IP, shortName string, longName string, description string)

+ func IPMask(assignmentVar *net.IPMask, shortName string, longName string, ...)

+ func IPMaskSlice(assignmentVar *[]net.IPMask, shortName string, longName string, ...)

+ func IPSlice(assignmentVar *[]net.IP, shortName string, longName string, description string)

+ func Int(assignmentVar *int, shortName string, longName string, description string)

+ func Int16(assignmentVar *int16, shortName string, longName string, description string)

+ func Int16Slice(assignmentVar *[]int16, shortName string, longName string, description string)

+ func Int32(assignmentVar *int32, shortName string, longName string, description string)

+ func Int32Slice(assignmentVar *[]int32, shortName string, longName string, description string)

+ func Int64(assignmentVar *int64, shortName string, longName string, description string)

+ func Int64Slice(assignmentVar *[]int64, shortName string, longName string, description string)

+ func Int8(assignmentVar *int8, shortName string, longName string, description string)

+ func Int8Slice(assignmentVar *[]int8, shortName string, longName string, description string)

+ func IntSlice(assignmentVar *[]int, shortName string, longName string, description string)

+ func Parse()

+ func ParseArgs(args []string)

+ func ResetParser()

+ func SetDescription(description string)

+ func SetName(name string)

+ func SetVersion(version string)

+ func ShowHelp(message string)

+ func ShowHelpAndExit(message string)

+ func String(assignmentVar *string, shortName string, longName string, description string)

+ func StringSlice(assignmentVar *[]string, shortName string, longName string, description string)

+ func UInt(assignmentVar *uint, shortName string, longName string, description string)

+ func UInt16(assignmentVar *uint16, shortName string, longName string, description string)

+ func UInt16Slice(assignmentVar *[]uint16, shortName string, longName string, description string)

+ func UInt32(assignmentVar *uint32, shortName string, longName string, description string)

+ func UInt32Slice(assignmentVar *[]uint32, shortName string, longName string, description string)

+ func UInt64(assignmentVar *uint64, shortName string, longName string, description string)

+ func UInt64Slice(assignmentVar *[]uint64, shortName string, longName string, description string)

+ func UInt8(assignmentVar *uint8, shortName string, longName string, description string)

+ func UInt8Slice(assignmentVar *[]uint8, shortName string, longName string, description string)

+ func UIntSlice(assignmentVar *[]uint, shortName string, longName string, description string)

+ type ArgumentParser interface

+ SetValueForKey func(key string, value string) (bool, error)

+ type Flag struct

+ AssignmentVar interface{}

+ Description string

+ Hidden bool

+ LongName string

+ ShortName string

+ func (f *Flag) HasName(name string) bool

+ type Help struct

+ AppendMessage string

+ CommandName string

+ Description string

+ Flags []HelpFlag

+ Message string

+ Positionals []HelpPositional

+ PrependMessage string

+ Subcommands []HelpSubcommand

+ UsageString string

+ func (h *Help) AddFlagToHelp(f HelpFlag)

+ func (h *Help) ExtractValues(p *Parser, message string)

+ type HelpFlag struct

+ DefaultValue string

+ Description string

+ LongName string

+ ShortName string

+ type HelpPositional struct

+ DefaultValue string

+ Description string

+ Name string

+ Position int

+ Required bool

+ type HelpSubcommand struct

+ Description string

+ LongName string

+ Position int

+ ShortName string

+ type Parser struct

+ HelpTemplate *template.Template

+ ShowHelpOnUnexpected bool

+ ShowHelpWithHFlag bool

+ ShowVersionWithVersionFlag bool

+ TrailingArguments []string

+ Version string

+ var DefaultParser *Parser

+ func NewParser(name string) *Parser

+ func (p *Parser) DisableShowVersionWithVersion()

+ func (p *Parser) Parse() error

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

+ func (p *Parser) SetHelpTemplate(tmpl string) error

+ func (p *Parser) ShowHelp()

+ func (p *Parser) ShowHelpAndExit(message string)

+ func (p *Parser) ShowHelpWithMessage(message string)

+ func (p *Parser) ShowVersionAndExit()

+ type PositionalValue struct

+ AssignmentVar *string

+ Description string

+ Found bool

+ Hidden bool

+ Name string

+ Position int

+ Required bool

+ type Subcommand struct

+ AdditionalHelpAppend string

+ AdditionalHelpPrepend string

+ Description string

+ Flags []*Flag

+ Hidden bool

+ Name string

+ Position int

+ PositionalFlags []*PositionalValue

+ ShortName string

+ Subcommands []*Subcommand

+ Used bool

+ func NewSubcommand(name string) *Subcommand

+ func (sc *Subcommand) AddPositionalValue(assignmentVar *string, name string, relativePosition int, required bool, ...)

+ func (sc *Subcommand) AttachSubcommand(newSC *Subcommand, relativePosition int)

+ func (sc *Subcommand) Bool(assignmentVar *bool, shortName string, longName string, description string)

+ func (sc *Subcommand) BoolSlice(assignmentVar *[]bool, shortName string, longName string, description string)

+ func (sc *Subcommand) ByteSlice(assignmentVar *[]byte, shortName string, longName string, description string)

+ func (sc *Subcommand) Duration(assignmentVar *time.Duration, shortName string, longName string, ...)

+ func (sc *Subcommand) DurationSlice(assignmentVar *[]time.Duration, shortName string, longName string, ...)

+ func (sc *Subcommand) FlagExists(name string) bool

+ func (sc *Subcommand) Float32(assignmentVar *float32, shortName string, longName string, description string)

+ func (sc *Subcommand) Float32Slice(assignmentVar *[]float32, shortName string, longName string, ...)

+ func (sc *Subcommand) Float64(assignmentVar *float64, shortName string, longName string, description string)

+ func (sc *Subcommand) Float64Slice(assignmentVar *[]float64, shortName string, longName string, ...)

+ func (sc *Subcommand) HardwareAddr(assignmentVar *net.HardwareAddr, shortName string, longName string, ...)

+ func (sc *Subcommand) HardwareAddrSlice(assignmentVar *[]net.HardwareAddr, shortName string, longName string, ...)

+ func (sc *Subcommand) IP(assignmentVar *net.IP, shortName string, longName string, description string)

+ func (sc *Subcommand) IPMask(assignmentVar *net.IPMask, shortName string, longName string, ...)

+ func (sc *Subcommand) IPMaskSlice(assignmentVar *[]net.IPMask, shortName string, longName string, ...)

+ func (sc *Subcommand) IPSlice(assignmentVar *[]net.IP, shortName string, longName string, description string)

+ func (sc *Subcommand) Int(assignmentVar *int, shortName string, longName string, description string)

+ func (sc *Subcommand) Int16(assignmentVar *int16, shortName string, longName string, description string)

+ func (sc *Subcommand) Int16Slice(assignmentVar *[]int16, shortName string, longName string, description string)

+ func (sc *Subcommand) Int32(assignmentVar *int32, shortName string, longName string, description string)

+ func (sc *Subcommand) Int32Slice(assignmentVar *[]int32, shortName string, longName string, description string)

+ func (sc *Subcommand) Int64(assignmentVar *int64, shortName string, longName string, description string)

+ func (sc *Subcommand) Int64Slice(assignmentVar *[]int64, shortName string, longName string, description string)

+ func (sc *Subcommand) Int8(assignmentVar *int8, shortName string, longName string, description string)

+ func (sc *Subcommand) Int8Slice(assignmentVar *[]int8, shortName string, longName string, description string)

+ func (sc *Subcommand) IntSlice(assignmentVar *[]int, shortName string, longName string, description string)

+ func (sc *Subcommand) SetValueForKey(key string, value string) (bool, error)

+ func (sc *Subcommand) String(assignmentVar *string, shortName string, longName string, description string)

+ func (sc *Subcommand) StringSlice(assignmentVar *[]string, shortName string, longName string, description string)

+ func (sc *Subcommand) UInt(assignmentVar *uint, shortName string, longName string, description string)

+ func (sc *Subcommand) UInt16(assignmentVar *uint16, shortName string, longName string, description string)

+ func (sc *Subcommand) UInt16Slice(assignmentVar *[]uint16, shortName string, longName string, description string)

+ func (sc *Subcommand) UInt32(assignmentVar *uint32, shortName string, longName string, description string)

+ func (sc *Subcommand) UInt32Slice(assignmentVar *[]uint32, shortName string, longName string, description string)

+ func (sc *Subcommand) UInt64(assignmentVar *uint64, shortName string, longName string, description string)

+ func (sc *Subcommand) UInt64Slice(assignmentVar *[]uint64, shortName string, longName string, description string)

+ func (sc *Subcommand) UInt8(assignmentVar *uint8, shortName string, longName string, description string)

+ func (sc *Subcommand) UInt8Slice(assignmentVar *[]uint8, shortName string, longName string, description string)

+ func (sc *Subcommand) UIntSlice(assignmentVar *[]uint, shortName string, longName string, description string)

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