cli

package module

Go to main page

Versions in this module

v3

v3.6.2

Jan 18, 2026

v3.6.1

Nov 16, 2025

Changes in this version

+ var ArgsUsageCommandHelp = "[command]"

+ var UsageCommandHelp = "Shows a list of commands or help for one command"

v3.6.0

Nov 9, 2025

Changes in this version

type Command

+ MapFlagKeyValueSeparator string

v3.5.0

Oct 21, 2025

Changes in this version

type Command

+ StopOnNthArg *int

v3.4.1

Aug 12, 2025

v3.4.0

Aug 12, 2025

Changes in this version

+ var ShowRootCommandHelp = DefaultShowRootCommandHelp

+ func DefaultPrintHelp(out io.Writer, templ string, data any)

+ func DefaultPrintHelpCustom(out io.Writer, templ string, data any, customFuncs map[string]any)

+ func DefaultPrintVersion(cmd *Command)

+ func DefaultRootCommandComplete(ctx context.Context, cmd *Command)

+ func DefaultShowCommandHelp(ctx context.Context, cmd *Command, commandName string) error

+ func DefaultShowRootCommandHelp(cmd *Command) error

+ func DefaultShowSubcommandHelp(cmd *Command) error

+ func ShowRootCommandHelpAndExit(cmd *Command, exitCode int)

+ type HelpPrinterCustomFunc func(w io.Writer, templ string, data any, customFunc map[string]any)

+ type HelpPrinterFunc func(w io.Writer, templ string, data any)

v3.3.9

Jul 13, 2025

v3.3.8

Jun 12, 2025

v3.3.7

Jun 6, 2025

Changes in this version

type BoolWithInverseFlag

+ func (bif *BoolWithInverseFlag) IsLocal() bool

v3.3.6

May 22, 2025

v3.3.5

May 21, 2025

Changes in this version

type BoolWithInverseFlag

+ func (bif *BoolWithInverseFlag) IsRequired() bool

+ func (bif *BoolWithInverseFlag) IsVisible() bool

v3.3.4

May 20, 2025

v3.3.3

May 10, 2025

v3.3.2

Apr 28, 2025

v3.3.1

Apr 27, 2025

v3.3.0

Apr 27, 2025

Changes in this version

+ var NewFloat32Slice = NewSliceBase[float32, NoConfig, floatValue[float32]]

+ var NewFloat64Slice = NewSliceBase[float64, NoConfig, floatValue[float64]]

type Command

+ ConfigureShellCompletionCommand ConfigureShellCompletionCommand

+ func (c *Command) Float32Arg(name string) float32

+ func (c *Command) Float32Args(name string) []float32

+ func (c *Command) Float64Arg(name string) float64

+ func (c *Command) Float64Args(name string) []float64

+ func (cmd *Command) Float32(name string) float32

+ func (cmd *Command) Float32Slice(name string) []float32

+ func (cmd *Command) Float64(name string) float64

+ func (cmd *Command) Float64Slice(name string) []float64

+ type ConfigureShellCompletionCommand func(*Command)

+ type Float32Arg = ArgumentBase[float32, NoConfig, floatValue[float32]]

+ type Float32Args = ArgumentsBase[float32, NoConfig, floatValue[float32]]

+ type Float32Flag = FlagBase[float32, NoConfig, floatValue[float32]]

+ type Float32Slice = SliceBase[float32, NoConfig, floatValue[float32]]

+ type Float32SliceFlag = FlagBase[[]float32, NoConfig, Float32Slice]

+ type Float64Arg = ArgumentBase[float64, NoConfig, floatValue[float64]]

+ type Float64Args = ArgumentsBase[float64, NoConfig, floatValue[float64]]

+ type Float64Flag = FlagBase[float64, NoConfig, floatValue[float64]]

+ type Float64Slice = SliceBase[float64, NoConfig, floatValue[float64]]

+ type Float64SliceFlag = FlagBase[[]float64, NoConfig, Float64Slice]

v3.2.0

Apr 20, 2025

Changes in this version

+ var NewInt16Slice = NewSliceBase[int16, IntegerConfig, intValue[int16]]

+ var NewInt32Slice = NewSliceBase[int32, IntegerConfig, intValue[int32]]

+ var NewInt64Slice = NewSliceBase[int64, IntegerConfig, intValue[int64]]

+ var NewInt8Slice = NewSliceBase[int8, IntegerConfig, intValue[int8]]

+ var NewUint16Slice = NewSliceBase[uint16, IntegerConfig, uintValue[uint16]]

+ var NewUint32Slice = NewSliceBase[uint32, IntegerConfig, uintValue[uint32]]

+ var NewUint64Slice = NewSliceBase[uint64, IntegerConfig, uintValue[uint64]]

+ var NewUint8Slice = NewSliceBase[uint8, IntegerConfig, uintValue[uint8]]

type Argument

+ Get func() any

+ HasName func(string) bool

type ArgumentBase

+ func (a *ArgumentBase[T, C, VC]) Get() any

+ func (a *ArgumentBase[T, C, VC]) HasName(s string) bool

+ type ArgumentsBase struct

+ Config C

+ Destination *[]T

+ Max int

+ Min int

+ Name string

+ UsageText string

+ Value T

+ func (a *ArgumentsBase[T, C, VC]) Get() any

+ func (a *ArgumentsBase[T, C, VC]) HasName(s string) bool

+ func (a *ArgumentsBase[T, C, VC]) Parse(s []string) ([]string, error)

+ func (a *ArgumentsBase[T, C, VC]) Usage() string

type Command

+ func (c *Command) FloatArg(name string) float64

+ func (c *Command) FloatArgs(name string) []float64

+ func (c *Command) Int16Arg(name string) int16

+ func (c *Command) Int16Args(name string) []int16

+ func (c *Command) Int32Arg(name string) int32

+ func (c *Command) Int32Args(name string) []int32

+ func (c *Command) Int64Arg(name string) int64

+ func (c *Command) Int64Args(name string) []int64

+ func (c *Command) Int8Arg(name string) int8

+ func (c *Command) Int8Args(name string) []int8

+ func (c *Command) IntArg(name string) int

+ func (c *Command) IntArgs(name string) []int

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

+ func (c *Command) StringArgs(name string) []string

+ func (c *Command) TimestampArg(name string) time.Time

+ func (c *Command) TimestampArgs(name string) []time.Time

+ func (c *Command) Uint16Arg(name string) uint16

+ func (c *Command) Uint16Args(name string) []uint16

+ func (c *Command) Uint32Arg(name string) uint32

+ func (c *Command) Uint32Args(name string) []uint32

+ func (c *Command) Uint64Arg(name string) uint64

+ func (c *Command) Uint64Args(name string) []uint64

+ func (c *Command) Uint8Arg(name string) uint8

+ func (c *Command) Uint8Args(name string) []uint8

+ func (c *Command) UintArg(name string) uint

+ func (c *Command) UintArgs(name string) []uint

+ func (cmd *Command) Int16(name string) int16

+ func (cmd *Command) Int16Slice(name string) []int16

+ func (cmd *Command) Int32(name string) int32

+ func (cmd *Command) Int32Slice(name string) []int32

+ func (cmd *Command) Int64(name string) int64

+ func (cmd *Command) Int64Slice(name string) []int64

+ func (cmd *Command) Int8(name string) int8

+ func (cmd *Command) Int8Slice(name string) []int8

+ func (cmd *Command) Uint16(name string) uint16

+ func (cmd *Command) Uint16Slice(name string) []uint16

+ func (cmd *Command) Uint32(name string) uint32

+ func (cmd *Command) Uint32Slice(name string) []uint32

+ func (cmd *Command) Uint64(name string) uint64

+ func (cmd *Command) Uint64Slice(name string) []uint64

+ func (cmd *Command) Uint8(name string) uint8

+ func (cmd *Command) Uint8Slice(name string) []uint8

+ type FloatArgs = ArgumentsBase[float64, NoConfig, floatValue]

+ type Int16Arg = ArgumentBase[int16, IntegerConfig, intValue[int16]]

+ type Int16Args = ArgumentsBase[int16, IntegerConfig, intValue[int16]]

+ type Int16Flag = FlagBase[int16, IntegerConfig, intValue[int16]]

+ type Int16Slice = SliceBase[int16, IntegerConfig, intValue[int16]]

+ type Int16SliceFlag = FlagBase[[]int16, IntegerConfig, Int16Slice]

+ type Int32Arg = ArgumentBase[int32, IntegerConfig, intValue[int32]]

+ type Int32Args = ArgumentsBase[int32, IntegerConfig, intValue[int32]]

+ type Int32Flag = FlagBase[int32, IntegerConfig, intValue[int32]]

+ type Int32Slice = SliceBase[int32, IntegerConfig, intValue[int32]]

+ type Int32SliceFlag = FlagBase[[]int32, IntegerConfig, Int32Slice]

+ type Int64Arg = ArgumentBase[int64, IntegerConfig, intValue[int64]]

+ type Int64Args = ArgumentsBase[int64, IntegerConfig, intValue[int64]]

+ type Int64Flag = FlagBase[int64, IntegerConfig, intValue[int64]]

+ type Int64Slice = SliceBase[int64, IntegerConfig, intValue[int64]]

+ type Int64SliceFlag = FlagBase[[]int64, IntegerConfig, Int64Slice]

+ type Int8Arg = ArgumentBase[int8, IntegerConfig, intValue[int8]]

+ type Int8Args = ArgumentsBase[int8, IntegerConfig, intValue[int8]]

+ type Int8Flag = FlagBase[int8, IntegerConfig, intValue[int8]]

+ type Int8Slice = SliceBase[int8, IntegerConfig, intValue[int8]]

+ type Int8SliceFlag = FlagBase[[]int8, IntegerConfig, Int8Slice]

+ type IntArgs = ArgumentsBase[int, IntegerConfig, intValue[int]]

+ type StringArgs = ArgumentsBase[string, StringConfig, stringValue]

+ type StringMapArgs = ArgumentBase[map[string]string, StringConfig, StringMap]

+ type TimestampArgs = ArgumentsBase[time.Time, TimestampConfig, timestampValue]

+ type Uint16Arg = ArgumentBase[uint16, IntegerConfig, uintValue[uint16]]

+ type Uint16Args = ArgumentsBase[uint16, IntegerConfig, uintValue[uint16]]

+ type Uint16Flag = FlagBase[uint16, IntegerConfig, uintValue[uint16]]

+ type Uint16Slice = SliceBase[uint16, IntegerConfig, uintValue[uint16]]

+ type Uint16SliceFlag = FlagBase[[]uint16, IntegerConfig, Uint16Slice]

+ type Uint32Arg = ArgumentBase[uint32, IntegerConfig, uintValue[uint32]]

+ type Uint32Args = ArgumentsBase[uint32, IntegerConfig, uintValue[uint32]]

+ type Uint32Flag = FlagBase[uint32, IntegerConfig, uintValue[uint32]]

+ type Uint32Slice = SliceBase[uint32, IntegerConfig, uintValue[uint32]]

+ type Uint32SliceFlag = FlagBase[[]uint32, IntegerConfig, Uint32Slice]

+ type Uint64Arg = ArgumentBase[uint64, IntegerConfig, uintValue[uint64]]

+ type Uint64Args = ArgumentsBase[uint64, IntegerConfig, uintValue[uint64]]

+ type Uint64Flag = FlagBase[uint64, IntegerConfig, uintValue[uint64]]

+ type Uint64Slice = SliceBase[uint64, IntegerConfig, uintValue[uint64]]

+ type Uint64SliceFlag = FlagBase[[]uint64, IntegerConfig, Uint64Slice]

+ type Uint8Arg = ArgumentBase[uint8, IntegerConfig, uintValue[uint8]]

+ type Uint8Args = ArgumentsBase[uint8, IntegerConfig, uintValue[uint8]]

+ type Uint8Flag = FlagBase[uint8, IntegerConfig, uintValue[uint8]]

+ type Uint8Slice = SliceBase[uint8, IntegerConfig, uintValue[uint8]]

+ type Uint8SliceFlag = FlagBase[[]uint8, IntegerConfig, Uint8Slice]

+ type UintArgs = ArgumentsBase[uint, IntegerConfig, uintValue[uint]]

v3.1.1

Apr 1, 2025

v3.1.0

Mar 31, 2025

Changes in this version

+ var AnyArguments = []Argument

+ var CommandHelpTemplate = ...

+ var DefaultInverseBoolPrefix = "no-"

+ var ErrWriter io.Writer = os.Stderr

+ var FishCompletionTemplate = ...

+ var HelpPrinter helpPrinter = printHelp

+ var HelpPrinterCustom helpPrinterCustom = printHelpCustom

+ var NewFloatSlice = NewSliceBase[float64, NoConfig, floatValue]

+ var NewIntSlice = NewSliceBase[int64, IntegerConfig, intValue]

+ var NewStringMap = NewMapBase[string, StringConfig, stringValue]

+ var NewStringSlice = NewSliceBase[string, StringConfig, stringValue]

+ var NewUintSlice = NewSliceBase[uint64, IntegerConfig, uintValue]

+ var OsExiter = os.Exit

+ var RootCommandHelpTemplate = ...

+ var SubcommandHelpTemplate = ...

+ var SuggestCommand SuggestCommandFunc = suggestCommand

+ var SuggestDidYouMeanTemplate string = suggestDidYouMeanTemplate

+ var SuggestFlag SuggestFlagFunc = suggestFlag

+ var VersionPrinter = printVersion

+ func DefaultAppComplete(ctx context.Context, cmd *Command)

+ func DefaultCompleteWithFlags(ctx context.Context, cmd *Command)

+ func FlagNames(name string, aliases []string) []string

+ func HandleExitCoder(err error)

+ func ShowAppHelp(cmd *Command) error

+ func ShowAppHelpAndExit(cmd *Command, exitCode int)

+ func ShowCommandHelp(ctx context.Context, cmd *Command, commandName string) error

+ func ShowCommandHelpAndExit(ctx context.Context, cmd *Command, command string, code int)

+ func ShowSubcommandHelp(cmd *Command) error

+ func ShowSubcommandHelpAndExit(cmd *Command, exitCode int)

+ func ShowVersion(cmd *Command)

+ type ActionFunc func(context.Context, *Command) error

+ type ActionableFlag interface

+ RunAction func(context.Context, *Command) error

+ type AfterFunc func(context.Context, *Command) error

+ type Args interface

+ First func() string

+ Get func(n int) string

+ Len func() int

+ Present func() bool

+ Slice func() []string

+ Tail func() []string

+ type Argument interface

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

+ Usage func() string

+ type ArgumentBase struct

+ Config C

+ Destination *T

+ Max int

+ Min int

+ Name string

+ UsageText string

+ Value T

+ Values *[]T

+ func (a *ArgumentBase[T, C, VC]) Parse(s []string) ([]string, error)

+ func (a *ArgumentBase[T, C, VC]) Usage() string

+ type BeforeFunc func(context.Context, *Command) (context.Context, error)

+ type BoolConfig struct

+ Count *int

+ type BoolFlag = FlagBase[bool, BoolConfig, boolValue]

+ type BoolWithInverseFlag struct

+ Action func(context.Context, *Command, bool) error

+ Aliases []string

+ Category string

+ Config BoolConfig

+ DefaultText string

+ Destination *bool

+ Hidden bool

+ HideDefault bool

+ InversePrefix string

+ Local bool

+ Name string

+ OnlyOnce bool

+ Required bool

+ Sources ValueSourceChain

+ TakesFile bool

+ Usage string

+ ValidateDefaults bool

+ Validator func(bool) error

+ Value bool

+ func (bif *BoolWithInverseFlag) Count() int

+ func (bif *BoolWithInverseFlag) Get() any

+ func (bif *BoolWithInverseFlag) GetCategory() string

+ func (bif *BoolWithInverseFlag) GetDefaultText() string

+ func (bif *BoolWithInverseFlag) GetEnvVars() []string

+ func (bif *BoolWithInverseFlag) GetUsage() string

+ func (bif *BoolWithInverseFlag) GetValue() string

+ func (bif *BoolWithInverseFlag) IsBoolFlag() bool

+ func (bif *BoolWithInverseFlag) IsDefaultVisible() bool

+ func (bif *BoolWithInverseFlag) IsSet() bool

+ func (bif *BoolWithInverseFlag) Names() []string

+ func (bif *BoolWithInverseFlag) PostParse() error

+ func (bif *BoolWithInverseFlag) PreParse() error

+ func (bif *BoolWithInverseFlag) RunAction(ctx context.Context, cmd *Command) error

+ func (bif *BoolWithInverseFlag) Set(name, val string) error

+ func (bif *BoolWithInverseFlag) SetCategory(c string)

+ func (bif *BoolWithInverseFlag) String() string

+ func (bif *BoolWithInverseFlag) TakesValue() bool

+ func (bif *BoolWithInverseFlag) TypeName() string

+ type CategorizableFlag interface

+ GetCategory func() string

+ SetCategory func(string)

+ type Command struct

+ Action ActionFunc

+ After AfterFunc

+ Aliases []string

+ AllowExtFlags bool

+ ArgsUsage string

+ Arguments []Argument

+ Authors []any

+ Before BeforeFunc

+ Category string

+ CommandNotFound CommandNotFoundFunc

+ Commands []*Command

+ Copyright string

+ CustomHelpTemplate string

+ CustomRootCommandHelpTemplate string

+ DefaultCommand string

+ Description string

+ DisableSliceFlagSeparator bool

+ EnableShellCompletion bool

+ ErrWriter io.Writer

+ ExitErrHandler ExitErrHandlerFunc

+ ExtraInfo func() map[string]string

+ Flags []Flag

+ Hidden bool

+ HideHelp bool

+ HideHelpCommand bool

+ HideVersion bool

+ InvalidFlagAccessHandler InvalidFlagAccessFunc

+ Metadata map[string]interface{}

+ MutuallyExclusiveFlags []MutuallyExclusiveFlags

+ Name string

+ OnUsageError OnUsageErrorFunc

+ PrefixMatchCommands bool

+ ReadArgsFromStdin bool

+ Reader io.Reader

+ ShellComplete ShellCompleteFunc

+ ShellCompletionCommandName string

+ SkipFlagParsing bool

+ SliceFlagSeparator string

+ Suggest bool

+ SuggestCommandFunc SuggestCommandFunc

+ Usage string

+ UsageText string

+ UseShortOptionHandling bool

+ Version string

+ Writer io.Writer

+ func (cmd *Command) Args() Args

+ func (cmd *Command) Bool(name string) bool

+ func (cmd *Command) Command(name string) *Command

+ func (cmd *Command) Count(name string) int

+ func (cmd *Command) Duration(name string) time.Duration

+ func (cmd *Command) FlagNames() []string

+ func (cmd *Command) Float(name string) float64

+ func (cmd *Command) FloatSlice(name string) []float64

+ func (cmd *Command) FullName() string

+ func (cmd *Command) Generic(name string) Value

+ func (cmd *Command) HasName(name string) bool

+ func (cmd *Command) Int(name string) int64

+ func (cmd *Command) IntSlice(name string) []int64

+ func (cmd *Command) IsSet(name string) bool

+ func (cmd *Command) Lineage() []*Command

+ func (cmd *Command) LocalFlagNames() []string

+ func (cmd *Command) NArg() int

+ func (cmd *Command) Names() []string

+ func (cmd *Command) NumFlags() int

+ func (cmd *Command) Root() *Command

+ func (cmd *Command) Run(ctx context.Context, osArgs []string) (deferErr error)

+ func (cmd *Command) Set(name, value string) error

+ func (cmd *Command) String(name string) string

+ func (cmd *Command) StringMap(name string) map[string]string

+ func (cmd *Command) StringSlice(name string) []string

+ func (cmd *Command) Timestamp(name string) time.Time

+ func (cmd *Command) ToFishCompletion() (string, error)

+ func (cmd *Command) Uint(name string) uint64

+ func (cmd *Command) UintSlice(name string) []uint64

+ func (cmd *Command) Value(name string) interface{}

+ func (cmd *Command) VisibleCategories() []CommandCategory

+ func (cmd *Command) VisibleCommands() []*Command

+ func (cmd *Command) VisibleFlagCategories() []VisibleFlagCategory

+ func (cmd *Command) VisibleFlags() []Flag

+ func (cmd *Command) VisiblePersistentFlags() []Flag

+ type CommandCategories interface

+ AddCommand func(category string, command *Command)

+ Categories func() []CommandCategory

+ type CommandCategory interface

+ Name func() string

+ VisibleCommands func() []*Command

+ type CommandNotFoundFunc func(context.Context, *Command, string)

+ type Countable interface

+ Count func() int

+ type DocGenerationFlag interface

+ GetDefaultText func() string

+ GetEnvVars func() []string

+ GetUsage func() string

+ GetValue func() string

+ IsDefaultVisible func() bool

+ TakesValue func() bool

+ TypeName func() string

+ type DocGenerationMultiValueFlag interface

+ IsMultiValueFlag func() bool

+ type DurationFlag = FlagBase[time.Duration, NoConfig, durationValue]

+ type EnvValueSource interface

+ IsFromEnv func() bool

+ Key func() string

+ type ErrorFormatter interface

+ Format func(s fmt.State, verb rune)

+ type ExitCoder interface

+ ExitCode func() int

+ func Exit(message interface{}, exitCode int) ExitCoder

+ type ExitErrHandlerFunc func(context.Context, *Command, error)

+ type Flag interface

+ Get func() any

+ IsSet func() bool

+ Names func() []string

+ PostParse func() error

+ PreParse func() error

+ Set func(string, string) error

+ var GenerateShellCompletionFlag Flag = &BoolFlag{ ... }

+ var HelpFlag Flag = &BoolFlag{ ... }

+ var VersionFlag Flag = &BoolFlag{ ... }

+ type FlagBase struct

+ Action func(context.Context, *Command, T) error

+ Aliases []string

+ Category string

+ Config C

+ DefaultText string

+ Destination *T

+ Hidden bool

+ HideDefault bool

+ Local bool

+ Name string

+ OnlyOnce bool

+ Required bool

+ Sources ValueSourceChain

+ TakesFile bool

+ Usage string

+ ValidateDefaults bool

+ Validator func(T) error

+ Value T

+ func (f *FlagBase[T, C, VC]) Count() int

+ func (f *FlagBase[T, C, VC]) IsBoolFlag() bool

+ func (f *FlagBase[T, C, VC]) IsLocal() bool

+ func (f *FlagBase[T, C, VC]) IsMultiValueFlag() bool

+ func (f *FlagBase[T, C, V]) Get() any

+ func (f *FlagBase[T, C, V]) GetCategory() string

+ func (f *FlagBase[T, C, V]) GetDefaultText() string

+ func (f *FlagBase[T, C, V]) GetEnvVars() []string

+ func (f *FlagBase[T, C, V]) GetUsage() string

+ func (f *FlagBase[T, C, V]) GetValue() string

+ func (f *FlagBase[T, C, V]) IsDefaultVisible() bool

+ func (f *FlagBase[T, C, V]) IsRequired() bool

+ func (f *FlagBase[T, C, V]) IsSet() bool

+ func (f *FlagBase[T, C, V]) IsVisible() bool

+ func (f *FlagBase[T, C, V]) Names() []string

+ func (f *FlagBase[T, C, V]) PostParse() error

+ func (f *FlagBase[T, C, V]) PreParse() error

+ func (f *FlagBase[T, C, V]) RunAction(ctx context.Context, cmd *Command) error

+ func (f *FlagBase[T, C, V]) Set(_ string, val string) error

+ func (f *FlagBase[T, C, V]) SetCategory(c string)

+ func (f *FlagBase[T, C, V]) String() string

+ func (f *FlagBase[T, C, V]) TakesValue() bool

+ func (f *FlagBase[T, C, V]) TypeName() string

+ type FlagCategories interface

+ AddFlag func(category string, fl Flag)

+ VisibleCategories func() []VisibleFlagCategory

+ type FlagEnvHintFunc func(envVars []string, str string) string

+ var FlagEnvHinter FlagEnvHintFunc = withEnvHint

+ type FlagFileHintFunc func(filePath, str string) string

+ var FlagFileHinter FlagFileHintFunc = withFileHint

+ type FlagNamePrefixFunc func(fullName []string, placeholder string) string

+ var FlagNamePrefixer FlagNamePrefixFunc = prefixedNames

+ type FlagStringFunc func(Flag) string

+ var FlagStringer FlagStringFunc = stringifyFlag

+ type FlagsByName []Flag

+ func (f FlagsByName) Len() int

+ func (f FlagsByName) Less(i, j int) bool

+ func (f FlagsByName) Swap(i, j int)

+ type FloatArg = ArgumentBase[float64, NoConfig, floatValue]

+ type FloatFlag = FlagBase[float64, NoConfig, floatValue]

+ type FloatSlice = SliceBase[float64, NoConfig, floatValue]

+ type FloatSliceFlag = FlagBase[[]float64, NoConfig, FloatSlice]

+ type GenericFlag = FlagBase[Value, NoConfig, genericValue]

+ type IntArg = ArgumentBase[int64, IntegerConfig, intValue]

+ type IntFlag = FlagBase[int64, IntegerConfig, intValue]

+ type IntSlice = SliceBase[int64, IntegerConfig, intValue]

+ type IntSliceFlag = FlagBase[[]int64, IntegerConfig, IntSlice]

+ type IntegerConfig struct

+ Base int

+ type InvalidFlagAccessFunc func(context.Context, *Command, string)

+ type LocalFlag interface

+ IsLocal func() bool

+ type MapBase struct

+ func NewMapBase[T any, C any, VC ValueCreator[T, C]](defaults map[string]T) *MapBase[T, C, VC]

+ func (i *MapBase[T, C, VC]) Get() interface{}

+ func (i *MapBase[T, C, VC]) Serialize() string

+ func (i *MapBase[T, C, VC]) Set(value string) error

+ func (i *MapBase[T, C, VC]) String() string

+ func (i *MapBase[T, C, VC]) Value() map[string]T

+ func (i MapBase[T, C, VC]) Create(val map[string]T, p *map[string]T, c C) Value

+ func (i MapBase[T, C, VC]) ToString(t map[string]T) string

+ type MapSource interface

+ Lookup func(string) (any, bool)

+ func NewMapSource(name string, m map[any]any) MapSource

+ type MultiError interface

+ Errors func() []error

+ type MutuallyExclusiveFlags struct

+ Category string

+ Flags [][]Flag

+ Required bool

+ type NoConfig struct

+ type OnUsageErrorFunc func(ctx context.Context, cmd *Command, err error, isSubcommand bool) error

+ type RequiredFlag interface

+ IsRequired func() bool

+ type Serializer interface

+ Serialize func() string

+ type ShellCompleteFunc func(context.Context, *Command)

+ type SliceBase struct

+ func NewSliceBase[T any, C any, VC ValueCreator[T, C]](defaults ...T) *SliceBase[T, C, VC]

+ func (i *SliceBase[T, C, VC]) Get() interface{}

+ func (i *SliceBase[T, C, VC]) Serialize() string

+ func (i *SliceBase[T, C, VC]) Set(value string) error

+ func (i *SliceBase[T, C, VC]) String() string

+ func (i *SliceBase[T, C, VC]) Value() []T

+ func (i SliceBase[T, C, VC]) Create(val []T, p *[]T, c C) Value

+ func (i SliceBase[T, C, VC]) ToString(t []T) string

+ type StringArg = ArgumentBase[string, StringConfig, stringValue]

+ type StringConfig struct

+ TrimSpace bool

+ type StringFlag = FlagBase[string, StringConfig, stringValue]

+ type StringMap = MapBase[string, StringConfig, stringValue]

+ type StringMapArg = ArgumentBase[map[string]string, StringConfig, StringMap]

+ type StringMapFlag = FlagBase[map[string]string, StringConfig, StringMap]

+ type StringSlice = SliceBase[string, StringConfig, stringValue]

+ type StringSliceFlag = FlagBase[[]string, StringConfig, StringSlice]

+ type SuggestCommandFunc func(commands []*Command, provided string) string

+ type SuggestFlagFunc func(flags []Flag, provided string, hideHelp bool) string

+ type TimestampArg = ArgumentBase[time.Time, TimestampConfig, timestampValue]

+ type TimestampConfig struct

+ Layouts []string

+ Timezone *time.Location

+ type TimestampFlag = FlagBase[time.Time, TimestampConfig, timestampValue]

+ type UintArg = ArgumentBase[uint64, IntegerConfig, uintValue]

+ type UintFlag = FlagBase[uint64, IntegerConfig, uintValue]

+ type UintSlice = SliceBase[uint64, IntegerConfig, uintValue]

+ type UintSliceFlag = FlagBase[[]uint64, IntegerConfig, UintSlice]

+ type Value interface

+ type ValueCreator interface

+ Create func(T, *T, C) Value

+ ToString func(T) string

+ type ValueSource interface

+ Lookup func() (string, bool)

+ func EnvVar(key string) ValueSource

+ func File(path string) ValueSource

+ func NewMapValueSource(key string, ms MapSource) ValueSource

+ type ValueSourceChain struct

+ Chain []ValueSource

+ func EnvVars(keys ...string) ValueSourceChain

+ func Files(paths ...string) ValueSourceChain

+ func NewValueSourceChain(src ...ValueSource) ValueSourceChain

+ func (vsc *ValueSourceChain) Append(other ValueSourceChain)

+ func (vsc *ValueSourceChain) EnvKeys() []string

+ func (vsc *ValueSourceChain) GoString() string

+ func (vsc *ValueSourceChain) Lookup() (string, bool)

+ func (vsc *ValueSourceChain) LookupWithSource() (string, ValueSource, bool)

+ func (vsc *ValueSourceChain) String() string

+ type VisibleFlag interface

+ IsVisible func() bool

+ type VisibleFlagCategory interface

+ Flags func() []Flag

+ Name func() string

v3.0.0-beta1

Nov 30, 2024

v3.0.0-alpha9.10

Nov 29, 2024

v3.0.0-alpha9.9

Nov 29, 2024

v3.0.0-alpha9.8

Nov 29, 2024

v3.0.0-alpha9.7

Nov 27, 2024

v3.0.0-alpha9.6

Nov 25, 2024

v3.0.0-alpha9.5

Nov 24, 2024

v3.0.0-alpha9.4

Nov 22, 2024

v3.0.0-alpha9.3

Nov 8, 2024

v3.0.0-alpha9.2

Oct 28, 2024

v3.0.0-alpha9.1

Oct 13, 2024

v3.0.0-alpha9

Feb 12, 2024

v3.0.0-alpha8

Dec 27, 2023

v3.0.0-alpha7

Dec 9, 2023

v3.0.0-alpha6

Dec 4, 2023

v3.0.0-alpha5

Nov 27, 2023

v3.0.0-alpha4

Jun 21, 2023

v3.0.0-alpha3

May 1, 2023

v3.0.0-alpha2

Jan 18, 2023

v3.0.0-alpha10

Oct 13, 2024

v3.0.0-alpha

Nov 8, 2022

Other modules containing this package

github.com/urfave/cli

github.com/urfave/cli/v2

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