flags

package module

Go to main page

Versions in this module

v0

v0.6.1

May 11, 2026

v0.6.0

May 10, 2026

Changes in this version

+ const FlagTagDefaultCommand

type Command

+ func (c *Command) SetDefaultSubcommand(name string)

type DocOption

+ func WithBuiltinCommands(names []string) DocOption

type Parser

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

+ func (p *Parser) SetManSection(section int)

+ func (p *Parser) SetSeeAlso(refs ...string)

+ func (p *Parser) SetVersionAuthor(author string)

+ func (p *Parser) SetVersionBugsURL(url string)

+ func (p *Parser) SetVersionLicense(license string)

+ func (p *Parser) SetVersionShort(short bool)

type VersionFields

+ const VersionFieldAuthor

+ const VersionFieldBugsURL

+ const VersionFieldLicense

type VersionInfo

+ Author string

+ BugsURL string

+ License string

v0.5.0

May 7, 2026

Changes in this version

+ const FlagTagDeprecated

+ const SilenceDeprecationWarnings

type Arg

+ func (a *Arg) SetCompletionFunc(fn func(match string) []Completion)

type Command

+ Deprecated string

+ func (c *Command) IsDeprecated() bool

+ func (c *Command) SetDeprecated(msg string)

type DocFormat

+ const DocFormatJSON

type FlagTags

+ Deprecated string

+ type HelpRenderOptions struct

+ EnvStyle RenderStyle

+ FlagStyle RenderStyle

+ IncludeHidden bool

+ Width int

type Option

+ Deprecated string

+ func (option *Option) IsDeprecated() bool

+ func (option *Option) SetCompletionFunc(fn func(match string) []Completion)

+ func (option *Option) SetDeprecated(msg string)

type Parser

+ func (p *Parser) WriteHelpWithOptions(writer io.Writer, opts HelpRenderOptions)

v0.4.0

May 6, 2026

Changes in this version

+ const FlagTagSecret

type DocOption

+ func WithDocWrapWidth(width int) DocOption

type FlagTags

+ Secret string

type HelpColorScheme

+ Banner HelpTextStyle

+ HelpFooter HelpTextStyle

+ HelpHeader HelpTextStyle

type Option

+ Secret bool

+ func (option *Option) IsSecret() bool

+ func (option *Option) SetSecret(secret bool)

type Parser

+ func (p *Parser) SetBanner(text string)

+ func (p *Parser) SetHelpFooter(text string)

+ func (p *Parser) SetHelpHeader(text string)

+ func (p *Parser) WriteBanner(writer io.Writer)

v0.3.3

May 5, 2026

Changes in this version

type DocOption

+ func WithDocRenderStyle(style RenderStyle) DocOption

type Parser

+ func (p *Parser) SetBuiltinCommandHidden(name string, hidden bool) error

v0.3.2

May 2, 2026

v0.3.1

May 2, 2026

v0.3.0

May 2, 2026

Changes in this version

+ type CommandDescriptionI18nKeys struct

+ Long string

+ Short string

+ type CommandDescriptions struct

+ Long string

+ Short string

type DocOption

+ func WithProgramName(name string) DocOption

+ func WithTOC(enabled bool) DocOption

+ func WithTrimDescriptions(enabled bool) DocOption

type Parser

+ func (p *Parser) SetCommandDescriptionI18nKeys(keys map[string]CommandDescriptionI18nKeys)

+ func (p *Parser) SetCommandDescriptions(descriptions map[string]CommandDescriptions)

+ func (p *Parser) SetCommandLongDescriptionI18nKeys(keys map[string]string)

+ func (p *Parser) SetCommandLongDescriptions(descriptions map[string]string)

+ func (p *Parser) SetCommandShortDescriptionI18nKeys(keys map[string]string)

+ func (p *Parser) SetCommandShortDescriptions(descriptions map[string]string)

v0.2.0

May 1, 2026

Changes in this version

+ const CommandChain

+ const FlagTagAnd

+ const FlagTagCounter

+ const FlagTagIO

+ const FlagTagIOKind

+ const FlagTagIOOpen

+ const FlagTagIOStream

+ const FlagTagValidateExistingDir

+ const FlagTagValidateExistingFile

+ const FlagTagValidateMax

+ const FlagTagValidateMaxLen

+ const FlagTagValidateMin

+ const FlagTagValidateMinLen

+ const FlagTagValidateNonEmpty

+ const FlagTagValidatePathAbs

+ const FlagTagValidateReadable

+ const FlagTagValidateRegex

+ const FlagTagValidateWritable

+ const FlagTagXor

+ var ErrCounterIncrementTooLarge = errors.New("counter increment is too large")

+ var ErrCounterInvalidType = errors.New("counter option must use integer type")

+ var ErrCounterNonNegative = errors.New("counter increment must be non-negative")

+ var ErrCounterOverflow = errors.New("counter overflow")

+ var ErrRequiredRangeMissingMinimum = errors.New("missing minimum")

type ErrorType

+ const ErrOptionConflict

+ const ErrOptionRequirement

+ const ErrValidation

type FlagTags

+ And string

+ Counter string

+ IO string

+ IOKind string

+ IOOpen string

+ IOStream string

+ ValidateExistingDir string

+ ValidateExistingFile string

+ ValidateMax string

+ ValidateMaxLen string

+ ValidateMin string

+ ValidateMinLen string

+ ValidateNonEmpty string

+ ValidatePathAbs string

+ ValidateReadable string

+ ValidateRegex string

+ ValidateWritable string

+ Xor string

type Option

+ AndGroups []string

+ Counter bool

+ XorGroups []string

+ func (option *Option) SetAndGroups(groups ...string)

+ func (option *Option) SetRequiredRange(requiredMin int, requiredMax int) error

+ func (option *Option) SetXorGroups(groups ...string)

v0.1.1

Apr 27, 2026

Changes in this version

+ const AutoShowChoiceListInHelp

v0.1.0

Apr 26, 2026

Changes in this version

+ const AllowBoolValues

+ const ColorErrors

+ const ColorHelp

+ const CompletionCommand

+ const ConfigCommand

+ const ConfiguredValues

+ const Default

+ const DefaultMaxLongNameLength

+ const DefaultsIfEmpty

+ const DetectShellEnvStyle

+ const DetectShellFlagStyle

+ const DocTemplateHTMLDefault

+ const DocTemplateHTMLStyled

+ const DocTemplateManDefault

+ const DocTemplateMarkdownCode

+ const DocTemplateMarkdownList

+ const DocTemplateMarkdownTable

+ const DocsCommand

+ const EnvProvisioning

+ const FlagTagAlias

+ const FlagTagAliases

+ const FlagTagArgDescriptionI18n

+ const FlagTagArgNameI18n

+ const FlagTagAutoEnv

+ const FlagTagBase

+ const FlagTagChoice

+ const FlagTagChoices

+ const FlagTagCommand

+ const FlagTagCommandGroup

+ const FlagTagCommandI18n

+ const FlagTagCompletion

+ const FlagTagDefault

+ const FlagTagDefaultMask

+ const FlagTagDefaults

+ const FlagTagDescription

+ const FlagTagDescriptionI18n

+ const FlagTagEnv

+ const FlagTagEnvDelim

+ const FlagTagEnvNamespace

+ const FlagTagGroup

+ const FlagTagGroupI18n

+ const FlagTagHidden

+ const FlagTagImmediate

+ const FlagTagIniGroup

+ const FlagTagIniName

+ const FlagTagKeyValueDelimiter

+ const FlagTagLong

+ const FlagTagLongAlias

+ const FlagTagLongAliases

+ const FlagTagLongDescription

+ const FlagTagLongDescriptionI18n

+ const FlagTagNamespace

+ const FlagTagNoFlag

+ const FlagTagNoIni

+ const FlagTagOptional

+ const FlagTagOptionalValue

+ const FlagTagOrder

+ const FlagTagPassAfterNonOption

+ const FlagTagPositionalArgName

+ const FlagTagPositionalArgs

+ const FlagTagRequired

+ const FlagTagShort

+ const FlagTagShortAlias

+ const FlagTagShortAliases

+ const FlagTagSubCommandsOptional

+ const FlagTagTerminator

+ const FlagTagUnquote

+ const FlagTagValueName

+ const FlagTagValueNameI18n

+ const HelpCommand

+ const HelpCommands

+ const HelpFlag

+ const HideEnvInHelp

+ const IgnoreUnknown

+ const IniCommentDefaults

+ const IniDefault

+ const IniIncludeComments

+ const IniIncludeDefaults

+ const IniNone

+ const KeepDescriptionWhitespace

+ const None

+ const PassAfterNonOption

+ const PassDoubleDash

+ const PrintErrors

+ const PrintErrorsOnStdout

+ const PrintHelpOnInputErrors

+ const PrintHelpOnStderr

+ const RequiredFromValues

+ const SetTerminalTitle

+ const ShowChoiceListInHelp

+ const ShowCommandAliases

+ const ShowRepeatableInHelp

+ const VersionCommand

+ const VersionFlag

+ var ErrEmptyCommandName = errors.New("command name must not be empty")

+ var ErrI18nInvalidJSONCatalog = errors.New("invalid i18n json catalog format")

+ var ErrNULTagListDelimiter = errors.New("tag list delimiter cannot be NUL")

+ var ErrNegativeCommandOptionIndent = errors.New("command option indent cannot be negative")

+ var ErrNegativeHelpWidth = errors.New("help width cannot be negative")

+ var ErrNegativeMaxLongNameLength = errors.New("max long name length cannot be negative")

+ var ErrNilWriter = errors.New("nil writer")

+ var ErrNotPointerToStruct = errors.New("provided data is not a pointer to struct")

+ var ErrSetConsoleTitleFailed = errors.New("SetConsoleTitleW failed")

+ func DetectColorSupport(writer io.Writer) bool

+ func DetectFDTTY(fd uintptr) bool

+ func DetectFileTTY(file *os.File) bool

+ func DetectLocale() string

+ func DetectShell() string

+ func DetectTerminalSize() (int, int)

+ func DetectWriterTTY(writer io.Writer) bool

+ func IniParse(filename string, data any) error

+ func ListBuiltinTemplates() []string

+ func Parse(data any) ([]string, error)

+ func ParseArgs(data any, args []string) ([]string, error)

+ func RuntimeOS() string

+ func WriteBuiltinTemplate(w io.Writer, name string) error

+ func WroteHelp(err error) bool

+ type ANSIColor uint8

+ const ColorBlack

+ const ColorBlue

+ const ColorBrightBlack

+ const ColorBrightBlue

+ const ColorBrightCyan

+ const ColorBrightGreen

+ const ColorBrightMagenta

+ const ColorBrightRed

+ const ColorBrightWhite

+ const ColorBrightYellow

+ const ColorCyan

+ const ColorGreen

+ const ColorMagenta

+ const ColorRed

+ const ColorWhite

+ const ColorYellow

+ type Arg struct

+ Default []string

+ Description string

+ DescriptionI18nKey string

+ Name string

+ NameI18nKey string

+ Required int

+ RequiredMaximum int

+ func (a *Arg) SetDefault(values ...string)

+ func (a *Arg) SetDescription(description string)

+ func (a *Arg) SetDescriptionI18nKey(key string)

+ func (a *Arg) SetName(name string)

+ func (a *Arg) SetNameI18nKey(key string)

+ func (a *Arg) SetRequired(required bool)

+ func (a *Arg) SetRequiredRange(requiredMin int, requiredMax int) error

+ type Command struct

+ Active *Command

+ Aliases []string

+ ArgsRequired bool

+ CommandGroup string

+ CommandGroupI18nKey string

+ Name string

+ Order int

+ PassAfterNonOption bool

+ SubcommandsOptional bool

+ func (c *Command) AddAlias(alias string)

+ func (c *Command) AddCommand(command string, shortDescription string, longDescription string, data any) (*Command, error)

+ func (c *Command) AddGroup(shortDescription string, longDescription string, data any) (*Group, error)

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

+ func (c *Command) Commands() []*Command

+ func (c *Command) Find(name string) *Command

+ func (c *Command) FindOptionByLongName(longName string) (option *Option)

+ func (c *Command) FindOptionByShortName(shortName rune) (option *Option)

+ func (c *Command) SetAliases(aliases ...string)

+ func (c *Command) SetArgsRequired(required bool)

+ func (c *Command) SetCommandGroup(group string)

+ func (c *Command) SetHidden(hidden bool)

+ func (c *Command) SetIniName(name string)

+ func (c *Command) SetLongDescription(description string)

+ func (c *Command) SetLongDescriptionI18nKey(key string)

+ func (c *Command) SetName(name string)

+ func (c *Command) SetOrder(order int)

+ func (c *Command) SetPassAfterNonOption(enabled bool)

+ func (c *Command) SetShortDescription(description string)

+ func (c *Command) SetShortDescriptionI18nKey(key string)

+ func (c *Command) SetSubcommandsOptional(optional bool)

+ type CommandSortMode uint8

+ const CommandSortByDeclaration

+ const CommandSortByNameAsc

+ const CommandSortByNameDesc

+ type Commander interface

+ Execute func(args []string) error

+ type Completer interface

+ Complete func(match string) []Completion

+ type Completion struct

+ Description string

+ Item string

+ type CompletionShell string

+ const CompletionShellBash

+ const CompletionShellPwsh

+ const CompletionShellZsh

+ func DetectCompletionShell() CompletionShell

+ type Configurer interface

+ ConfigureFlags func(parser *Parser) error

+ type DefaultProvider interface

+ Default func() ([]string, error)

+ type DocFormat string

+ const DocFormatHTML

+ const DocFormatMan

+ const DocFormatMarkdown

+ type DocOption func(*docRenderOptions) error

+ func WithBuiltinTemplate(name string) DocOption

+ func WithIncludeHidden(include bool) DocOption

+ func WithMarkHidden(mark bool) DocOption

+ func WithTemplateBytes(data []byte) DocOption

+ func WithTemplateData(data map[string]any) DocOption

+ func WithTemplateString(text string) DocOption

+ type EnvironmentInfo struct

+ CompletionShell CompletionShell

+ Locale string

+ OS string

+ Shell string

+ ShellStyle RenderStyle

+ TTY TTYInfo

+ TerminalColumns int

+ TerminalRows int

+ func DetectEnvironment() EnvironmentInfo

+ type Error struct

+ Message string

+ Type ErrorType

+ func (e *Error) Error() string

+ type ErrorColorScheme struct

+ Critical HelpTextStyle

+ Warning HelpTextStyle

+ func DefaultErrorColorScheme() ErrorColorScheme

+ func GrayErrorColorScheme() ErrorColorScheme

+ func HighContrastErrorColorScheme() ErrorColorScheme

+ type ErrorType uint

+ const ErrCommandRequired

+ const ErrDuplicatedFlag

+ const ErrExpectedArgument

+ const ErrHelp

+ const ErrInvalidChoice

+ const ErrInvalidTag

+ const ErrMarshal

+ const ErrNoArgumentForBool

+ const ErrRequired

+ const ErrShortNameTooLong

+ const ErrTag

+ const ErrUnknown

+ const ErrUnknownCommand

+ const ErrUnknownFlag

+ const ErrUnknownGroup

+ const ErrVersion

+ func (e ErrorType) Error() string

+ func (e ErrorType) IsWarning() bool

+ func (e ErrorType) String() string

+ type Filename string

+ func (f *Filename) Complete(match string) []Completion

+ type FlagTags struct

+ Alias string

+ Aliases string

+ ArgDescriptionI18n string

+ ArgNameI18n string

+ AutoEnv string

+ Base string

+ Choice string

+ Choices string

+ Command string

+ CommandGroup string

+ CommandI18n string

+ Completion string

+ Default string

+ DefaultMask string

+ Defaults string

+ Description string

+ DescriptionI18n string

+ Env string

+ EnvDelim string

+ EnvNamespace string

+ Group string

+ GroupI18n string

+ Hidden string

+ Immediate string

+ IniGroup string

+ IniName string

+ KeyValueDelimiter string

+ Long string

+ LongAlias string

+ LongAliases string

+ LongDescription string

+ LongDescriptionI18n string

+ Namespace string

+ NoFlag string

+ NoIni string

+ Optional string

+ OptionalValue string

+ Order string

+ PassAfterNonOption string

+ PositionalArgName string

+ PositionalArgs string

+ Required string

+ Short string

+ ShortAlias string

+ ShortAliases string

+ SubCommandsOptional string

+ Terminator string

+ Unquote string

+ ValueName string

+ ValueNameI18n string

+ func NewFlagTags() FlagTags

+ func NewFlagTagsWithPrefix(prefix string) FlagTags

+ type Group struct

+ EnvNamespace string

+ Hidden bool

+ Immediate bool

+ IniName string

+ LongDescription string

+ LongDescriptionI18nKey string

+ Namespace string

+ ShortDescription string

+ ShortDescriptionI18nKey string

+ func (g *Group) AddGroup(shortDescription string, longDescription string, data any) (*Group, error)

+ func (g *Group) AddOption(option *Option, data any)

+ func (g *Group) Data() any

+ func (g *Group) Find(shortDescription string) *Group

+ func (g *Group) FindOptionByLongName(longName string) *Option

+ func (g *Group) FindOptionByShortName(shortName rune) *Option

+ func (g *Group) Groups() []*Group

+ func (g *Group) Options() []*Option

+ func (g *Group) SetEnvNamespace(namespace string)

+ func (g *Group) SetHidden(hidden bool)

+ func (g *Group) SetImmediate(immediate bool)

+ func (g *Group) SetIniName(name string)

+ func (g *Group) SetLongDescription(description string)

+ func (g *Group) SetLongDescriptionI18nKey(key string)

+ func (g *Group) SetNamespace(namespace string)

+ func (g *Group) SetShortDescription(description string)

+ func (g *Group) SetShortDescriptionI18nKey(key string)

+ type HelpColorScheme struct

+ ArgumentDesc HelpTextStyle

+ ArgumentName HelpTextStyle

+ ArgumentsHeader HelpTextStyle

+ BaseText HelpTextStyle

+ CommandAliases HelpTextStyle

+ CommandDesc HelpTextStyle

+ CommandGroupHeader HelpTextStyle

+ CommandName HelpTextStyle

+ CommandSectionHeader HelpTextStyle

+ GroupHeader HelpTextStyle

+ LongDescription HelpTextStyle

+ OptionChoices HelpTextStyle

+ OptionDefault HelpTextStyle

+ OptionDesc HelpTextStyle

+ OptionEnv HelpTextStyle

+ OptionLong HelpTextStyle

+ OptionPunctuation HelpTextStyle

+ OptionShort HelpTextStyle

+ OptionValueName HelpTextStyle

+ SubcommandOptionsHeader HelpTextStyle

+ UsageHeader HelpTextStyle

+ UsageText HelpTextStyle

+ VersionLabel HelpTextStyle

+ VersionValue HelpTextStyle

+ func DefaultHelpColorScheme() HelpColorScheme

+ func GrayHelpColorScheme() HelpColorScheme

+ func HighContrastHelpColorScheme() HelpColorScheme

+ type HelpTextStyle struct

+ BG ANSIColor

+ Bold bool

+ FG ANSIColor

+ Italic bool

+ Underline bool

+ UseBG bool

+ UseFG bool

+ type I18nCatalog interface

+ Lookup func(locale, key string) (string, bool)

+ func NewJSONCatalog(data []byte) (I18nCatalog, error)

+ func NewJSONCatalogDirFS(fsys fs.FS, dir string) (I18nCatalog, error)

+ func NewJSONCatalogFS(fsys fs.FS, path string) (I18nCatalog, error)

+ type I18nConfig struct

+ FallbackLocales []string

+ Locale string

+ ModuleCatalog I18nCatalog

+ UserCatalog I18nCatalog

+ type I18nCoverageConfig struct

+ BaseLocale string

+ CheckPlaceholders bool

+ Locales []string

+ ModuleCatalog I18nCatalog

+ UserCatalog I18nCatalog

+ type I18nCoverageReport struct

+ Locale string

+ MissingKeys []string

+ PlaceholderMismatches []I18nPlaceholderMismatch

+ func CheckCatalogCoverage(catalog I18nCatalog, baseLocale string, locales ...string) ([]I18nCoverageReport, error)

+ func CheckMergedCatalogCoverage(cfg I18nCoverageConfig) ([]I18nCoverageReport, error)

+ type I18nPlaceholderMismatch struct

+ Base []string

+ Got []string

+ Key string

+ type IniError struct

+ File string

+ LineNumber uint

+ Message string

+ func (x *IniError) Error() string

+ type IniExampleOptions struct

+ CommentWidth int

+ type IniOptions uint

+ type IniParser struct

+ ParseAsDefaults bool

+ func NewIniParser(p *Parser) *IniParser

+ func (i *IniParser) Parse(reader io.Reader) error

+ func (i *IniParser) ParseFile(filename string) error

+ func (i *IniParser) Write(writer io.Writer, options IniOptions)

+ func (i *IniParser) WriteExample(writer io.Writer)

+ func (i *IniParser) WriteExampleWithOptions(writer io.Writer, opts IniExampleOptions)

+ func (i *IniParser) WriteFile(filename string, options IniOptions) error

+ type Localizer struct

+ func NewLocalizer(cfg I18nConfig) *Localizer

+ func (l *Localizer) LocaleChain() []string

+ func (l *Localizer) Localize(key, fallback string, data map[string]string) string

+ type Marshaler interface

+ MarshalFlag func() (string, error)

+ type Option struct

+ Choices []string

+ Default []string

+ DefaultMask string

+ Description string

+ DescriptionI18nKey string

+ EnvDefaultDelim string

+ EnvDefaultKey string

+ Hidden bool

+ Immediate bool

+ LongAliases []string

+ LongName string

+ OptionalArgument bool

+ OptionalValue []string

+ Order int

+ Required bool

+ ShortAliases []rune

+ ShortName rune

+ Terminator string

+ ValueName string

+ ValueNameI18nKey string

+ func (option *Option) AddLongAlias(alias string) error

+ func (option *Option) AddShortAlias(alias rune) error

+ func (option *Option) EnvKeyWithNamespace() string

+ func (option *Option) Field() reflect.StructField

+ func (option *Option) IsImmediate() bool

+ func (option *Option) IsSet() bool

+ func (option *Option) IsSetDefault() bool

+ func (option *Option) LongAliasesWithNamespace() []string

+ func (option *Option) LongNameWithNamespace() string

+ func (option *Option) Set(value *string) error

+ func (option *Option) SetAutoEnv(enabled bool) error

+ func (option *Option) SetBase(base int) error

+ func (option *Option) SetChoices(values ...string)

+ func (option *Option) SetDefault(values ...string)

+ func (option *Option) SetDefaultMask(mask string)

+ func (option *Option) SetDescription(description string)

+ func (option *Option) SetDescriptionI18nKey(key string)

+ func (option *Option) SetEnv(key string, delim string) error

+ func (option *Option) SetHidden(hidden bool)

+ func (option *Option) SetImmediate(immediate bool)

+ func (option *Option) SetIniName(name string)

+ func (option *Option) SetKeyValueDelimiter(delimiter string)

+ func (option *Option) SetLongAliases(aliases ...string) error

+ func (option *Option) SetLongName(name string) error

+ func (option *Option) SetNoIni(disabled bool)

+ func (option *Option) SetOptional(optional bool, values ...string)

+ func (option *Option) SetOrder(order int)

+ func (option *Option) SetRequired(required bool)

+ func (option *Option) SetShortAliases(aliases ...rune) error

+ func (option *Option) SetShortName(name rune) error

+ func (option *Option) SetTerminated(values []string) error

+ func (option *Option) SetTerminator(terminator string)

+ func (option *Option) SetUnquote(enabled bool)

+ func (option *Option) SetValueName(name string)

+ func (option *Option) SetValueNameI18nKey(key string)

+ func (option *Option) String() string

+ func (option *Option) Value() any

+ type OptionSortMode uint8

+ const OptionSortByDeclaration

+ const OptionSortByNameAsc

+ const OptionSortByNameDesc

+ const OptionSortByType

+ type OptionTypeClass uint8

+ const OptionTypeBool

+ const OptionTypeCollection

+ const OptionTypeCustom

+ const OptionTypeDuration

+ const OptionTypeNumber

+ const OptionTypeString

+ type Options uint

+ type Parser struct

+ CommandHandler func(command Commander, args []string) error

+ CompletionHandler func(items []Completion)

+ EnvNamespaceDelimiter string

+ EnvPrefix string

+ MaxLongNameLength int

+ NamespaceDelimiter string

+ Options Options

+ TagListDelimiter rune

+ TerminalTitle string

+ UnknownOptionHandler func(option string, arg SplitArgument, args []string) ([]string, error)

+ Usage string

+ func NewNamedParser(appname string, options Options) *Parser

+ func NewParser(data any, options Options) *Parser

+ func (p *Parser) BuiltinHelpOption() *Option

+ func (p *Parser) BuiltinVersionOption() *Option

+ func (p *Parser) DisableI18n()

+ func (p *Parser) EnsureBuiltinCommands() error

+ func (p *Parser) EnsureBuiltinOptions()

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

+ func (p *Parser) Localize(key, fallback string, data map[string]string) string

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

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

+ func (p *Parser) Rebuild() error

+ func (p *Parser) SetBuiltinCommandGroup(group string)

+ func (p *Parser) SetCommandOptionIndent(indent int) error

+ func (p *Parser) SetCommandSort(mode CommandSortMode)

+ func (p *Parser) SetEnvPrefix(prefix string)

+ func (p *Parser) SetErrorColorScheme(scheme ErrorColorScheme)

+ func (p *Parser) SetFlagTags(tags FlagTags) error

+ func (p *Parser) SetHelpColorScheme(scheme HelpColorScheme)

+ func (p *Parser) SetHelpEnvRenderStyle(style RenderStyle)

+ func (p *Parser) SetHelpFlagRenderStyle(style RenderStyle)

+ func (p *Parser) SetHelpWidth(width int) error

+ func (p *Parser) SetI18n(cfg I18nConfig)

+ func (p *Parser) SetI18nFallbackLocales(locales ...string)

+ func (p *Parser) SetMaxLongNameLength(length int) error

+ func (p *Parser) SetOptionSort(mode OptionSortMode)

+ func (p *Parser) SetOptionTypeOrder(order []OptionTypeClass) error

+ func (p *Parser) SetTagListDelimiter(delimiter rune) error

+ func (p *Parser) SetTagPrefix(prefix string) error

+ func (p *Parser) SetVersion(version string)

+ func (p *Parser) SetVersionCommit(revision string)

+ func (p *Parser) SetVersionFields(fields VersionFields)

+ func (p *Parser) SetVersionInfo(info VersionInfo)

+ func (p *Parser) SetVersionTarget(goos string, goarch string)

+ func (p *Parser) SetVersionTime(t time.Time)

+ func (p *Parser) SetVersionURL(url string)

+ func (p *Parser) Validate() error

+ func (p *Parser) VersionInfo() VersionInfo

+ func (p *Parser) WriteAutoCompletion(w io.Writer) error

+ func (p *Parser) WriteCompletion(w io.Writer, shell CompletionShell) error

+ func (p *Parser) WriteDoc(w io.Writer, format DocFormat, opts ...DocOption) error

+ func (p *Parser) WriteHelp(writer io.Writer)

+ func (p *Parser) WriteManPage(w io.Writer)

+ func (p *Parser) WriteNamedCompletion(w io.Writer, shell CompletionShell, commandName string) error

+ func (p *Parser) WriteVersion(w io.Writer, fields VersionFields)

+ type RenderStyle uint8

+ const RenderStyleAuto

+ const RenderStylePOSIX

+ const RenderStyleShell

+ const RenderStyleWindows

+ func DetectShellStyle() RenderStyle

+ type SplitArgument interface

+ Value func() (string, bool)

+ type TTYInfo struct

+ Stderr bool

+ Stdin bool

+ Stdout bool

+ func DetectTTY() TTYInfo

+ type Unmarshaler interface

+ UnmarshalFlag func(value string) error

+ type Usage interface

+ Usage func() string

+ type ValueValidator interface

+ IsValidValue func(value string) error

+ type VersionFields uint

+ const VersionFieldBuilt

+ const VersionFieldCommit

+ const VersionFieldFile

+ const VersionFieldGoVersion

+ const VersionFieldModified

+ const VersionFieldModule

+ const VersionFieldPath

+ const VersionFieldTarget

+ const VersionFieldURL

+ const VersionFieldVersion

+ const VersionFieldsAll

+ const VersionFieldsCore

+ type VersionInfo struct

+ File string

+ GOARCH string

+ GOOS string

+ GoVersion string

+ Modified bool

+ ModulePath string

+ Path string

+ Revision string

+ RevisionTime time.Time

+ URL string

+ Version string

+ func ReadVersionInfo() VersionInfo

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