cli

package module

Go to main page

Versions in this module

v0

v0.8.5

Jun 15, 2026

v0.8.4

Apr 28, 2026

v0.8.3

Apr 5, 2026

v0.8.2

Apr 5, 2026

v0.8.1

Apr 5, 2026

v0.8.0

Mar 28, 2026

v0.7.12

Mar 22, 2026

v0.7.11

Feb 26, 2026

Changes in this version

type ArgumentTyped

+ CompletionFunc func(ctx context.Context, cmd *Command) []CompletionItem

+ type CompletionItem struct

+ Description string

+ Value string

v0.7.10

Feb 25, 2026

v0.7.9

Feb 24, 2026

v0.7.8

Feb 23, 2026

v0.7.7

Feb 23, 2026

v0.7.6

Feb 22, 2026

v0.7.5

Feb 21, 2026

v0.7.4

Feb 20, 2026

v0.7.3

Feb 17, 2026

v0.7.2

Jan 10, 2026

v0.7.1

Jan 7, 2026

v0.7.0

Jan 7, 2026

v0.6.0

Dec 9, 2025

Changes in this version

type ConfigFileTyped

+ func NewTypedConfigObject() ConfigFileTyped

+ func NewTypedConfigObjectWithData(data map[string]any) ConfigFileTyped

+ GetObject func(string) ConfigFileTyped

+ GetObjectSlice func(string) []ConfigFileTyped

+ SetObject func(string, ConfigFileTyped) error

+ SetObjectSlice func(string, []ConfigFileTyped) error

type ConfigFileTypedWrapper

+ func (c *ConfigFileTypedWrapper) GetObject(path string) ConfigFileTyped

+ func (c *ConfigFileTypedWrapper) GetObjectSlice(path string) []ConfigFileTyped

+ func (c *ConfigFileTypedWrapper) SetObject(path string, obj ConfigFileTyped) error

+ func (c *ConfigFileTypedWrapper) SetObjectSlice(path string, objects []ConfigFileTyped) error

v0.5.0

Oct 24, 2025

v0.4.0

Oct 15, 2025

v0.3.0

Aug 11, 2025

v0.2.3

Jul 20, 2025

Changes in this version

+ var ConfigFileNotFoundError = fmt.Errorf("configuration file not found")

v0.2.2

Jul 20, 2025

v0.2.1

Jul 20, 2025

v0.2.0

Jul 20, 2025

Changes in this version

type ConfigFileSource

+ LoadData func() error

type ConfigFileTypedWrapper

+ func (c *ConfigFileTypedWrapper) LoadData() error

v0.1.0

Jul 5, 2025

Changes in this version

+ const NoArgs

+ const UnlimitedArgs

+ func GetTypeText(value interface{}) string

+ func StrToPtr(v string) *string

+ type Argument interface

+ type ArgumentTyped struct

+ AssignTo *T

+ Name string

+ Required bool

+ Usage string

+ ValidateArg func(*Command) error

+ type BoolArg = ArgumentTyped[bool]

+ type BoolFlag = FlagTyped[bool]

+ type Command struct

+ Arguments []Argument

+ Commands []*Command

+ ConfigFile ConfigFileSource

+ Description string

+ DisableHelp bool

+ DisableVersion bool

+ Flags []Flag

+ MaxArgs int

+ MinArgs int

+ Name string

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

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

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

+ Suggestions bool

+ Usage string

+ Version string

+ func GenerateCompletionCommand() *Command

+ func (c *Command) Execute(ctx context.Context) error

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

+ func (c *Command) GetBool(name string) bool

+ func (c *Command) GetBoolArg(name string) bool

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

+ func (c *Command) GetRootCmd() *Command

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

+ func (c *Command) HasArg(name string) bool

+ func (c *Command) HasFlag(name string) bool

+ func (c *Command) ReloadFlags() error

+ func (c *Command) ShowHelp()

+ type ConfigFileBase struct

+ FileName *string

+ Marshal ConfigFileMarshal

+ SearchPath SearchPathFunc

+ Unmarshal ConfigFileUnmarshal

+ func (c *ConfigFileBase) DeleteKey(path string) error

+ func (c *ConfigFileBase) FileUsed() string

+ func (c *ConfigFileBase) GetKeys(path string) []string

+ func (c *ConfigFileBase) GetValue(path string) (any, bool)

+ func (c *ConfigFileBase) InitConfigFile()

+ func (c *ConfigFileBase) LoadData() error

+ func (c *ConfigFileBase) OnChange(handler ConfigFileChangeHandler) error

+ func (c *ConfigFileBase) Save() error

+ func (c *ConfigFileBase) SetValue(path string, value any) error

+ type ConfigFileChangeHandler func()

+ type ConfigFileMarshal func(v any) ([]byte, error)

+ type ConfigFileSource interface

+ DeleteKey func(string) error

+ FileUsed func() string

+ GetKeys func(string) []string

+ GetValue func(string) (any, bool)

+ OnChange func(ConfigFileChangeHandler) error

+ Save func() error

+ SetValue func(string, any) error

+ type ConfigFileTyped interface

+ GetBool func(string) bool

+ GetFloat32 func(string) float32

+ GetFloat32Slice func(string) []float32

+ GetFloat64 func(string) float64

+ GetFloat64Slice func(string) []float64

+ GetInt func(string) int

+ GetInt16 func(string) int16

+ GetInt16Slice func(string) []int16

+ GetInt32 func(string) int32

+ GetInt32Slice func(string) []int32

+ GetInt64 func(string) int64

+ GetInt64Slice func(string) []int64

+ GetInt8 func(string) int8

+ GetInt8Slice func(string) []int8

+ GetIntSlice func(string) []int

+ GetString func(string) string

+ GetStringSlice func(string) []string

+ GetUint func(string) uint

+ GetUint16 func(string) uint16

+ GetUint16Slice func(string) []uint16

+ GetUint32 func(string) uint32

+ GetUint32Slice func(string) []uint32

+ GetUint64 func(string) uint64

+ GetUint64Slice func(string) []uint64

+ GetUint8 func(string) uint8

+ GetUint8Slice func(string) []uint8

+ GetUintSlice func(string) []uint

+ SetBool func(string, bool) error

+ SetFloat32 func(string, float32) error

+ SetFloat32Slice func(string, []float32) error

+ SetFloat64 func(string, float64) error

+ SetFloat64Slice func(string, []float64) error

+ SetInt func(string, int) error

+ SetInt16 func(string, int16) error

+ SetInt16Slice func(string, []int16) error

+ SetInt32 func(string, int32) error

+ SetInt32Slice func(string, []int32) error

+ SetInt64 func(string, int64) error

+ SetInt64Slice func(string, []int64) error

+ SetInt8 func(string, int8) error

+ SetInt8Slice func(string, []int8) error

+ SetIntSlice func(string, []int) error

+ SetString func(string, string) error

+ SetStringSlice func(string, []string) error

+ SetUint func(string, uint) error

+ SetUint16 func(string, uint16) error

+ SetUint16Slice func(string, []uint16) error

+ SetUint32 func(string, uint32) error

+ SetUint32Slice func(string, []uint32) error

+ SetUint64 func(string, uint64) error

+ SetUint64Slice func(string, []uint64) error

+ SetUint8 func(string, uint8) error

+ SetUint8Slice func(string, []uint8) error

+ SetUintSlice func(string, []uint) error

+ type ConfigFileTypedWrapper struct

+ func NewTypedConfigFile(inner ConfigFileSource) *ConfigFileTypedWrapper

+ func (c *ConfigFileTypedWrapper) GetBool(path string) bool

+ func (c *ConfigFileTypedWrapper) GetFloat32(path string) float32

+ func (c *ConfigFileTypedWrapper) GetFloat32Slice(path string) []float32

+ func (c *ConfigFileTypedWrapper) GetFloat64(path string) float64

+ func (c *ConfigFileTypedWrapper) GetFloat64Slice(path string) []float64

+ func (c *ConfigFileTypedWrapper) GetInt(path string) int

+ func (c *ConfigFileTypedWrapper) GetInt16(path string) int16

+ func (c *ConfigFileTypedWrapper) GetInt16Slice(path string) []int16

+ func (c *ConfigFileTypedWrapper) GetInt32(path string) int32

+ func (c *ConfigFileTypedWrapper) GetInt32Slice(path string) []int32

+ func (c *ConfigFileTypedWrapper) GetInt64(path string) int64

+ func (c *ConfigFileTypedWrapper) GetInt64Slice(path string) []int64

+ func (c *ConfigFileTypedWrapper) GetInt8(path string) int8

+ func (c *ConfigFileTypedWrapper) GetInt8Slice(path string) []int8

+ func (c *ConfigFileTypedWrapper) GetIntSlice(path string) []int

+ func (c *ConfigFileTypedWrapper) GetString(path string) string

+ func (c *ConfigFileTypedWrapper) GetStringSlice(path string) []string

+ func (c *ConfigFileTypedWrapper) GetUint(path string) uint

+ func (c *ConfigFileTypedWrapper) GetUint16(path string) uint16

+ func (c *ConfigFileTypedWrapper) GetUint16Slice(path string) []uint16

+ func (c *ConfigFileTypedWrapper) GetUint32(path string) uint32

+ func (c *ConfigFileTypedWrapper) GetUint32Slice(path string) []uint32

+ func (c *ConfigFileTypedWrapper) GetUint64(path string) uint64

+ func (c *ConfigFileTypedWrapper) GetUint64Slice(path string) []uint64

+ func (c *ConfigFileTypedWrapper) GetUint8(path string) uint8

+ func (c *ConfigFileTypedWrapper) GetUint8Slice(path string) []uint8

+ func (c *ConfigFileTypedWrapper) GetUintSlice(path string) []uint

+ func (c *ConfigFileTypedWrapper) SetBool(path string, value bool) error

+ func (c *ConfigFileTypedWrapper) SetFloat32(path string, value float32) error

+ func (c *ConfigFileTypedWrapper) SetFloat32Slice(path string, value []float32) error

+ func (c *ConfigFileTypedWrapper) SetFloat64(path string, value float64) error

+ func (c *ConfigFileTypedWrapper) SetFloat64Slice(path string, value []float64) error

+ func (c *ConfigFileTypedWrapper) SetInt(path string, value int) error

+ func (c *ConfigFileTypedWrapper) SetInt16(path string, value int16) error

+ func (c *ConfigFileTypedWrapper) SetInt16Slice(path string, value []int16) error

+ func (c *ConfigFileTypedWrapper) SetInt32(path string, value int32) error

+ func (c *ConfigFileTypedWrapper) SetInt32Slice(path string, value []int32) error

+ func (c *ConfigFileTypedWrapper) SetInt64(path string, value int64) error

+ func (c *ConfigFileTypedWrapper) SetInt64Slice(path string, value []int64) error

+ func (c *ConfigFileTypedWrapper) SetInt8(path string, value int8) error

+ func (c *ConfigFileTypedWrapper) SetInt8Slice(path string, value []int8) error

+ func (c *ConfigFileTypedWrapper) SetIntSlice(path string, value []int) error

+ func (c *ConfigFileTypedWrapper) SetString(path string, value string) error

+ func (c *ConfigFileTypedWrapper) SetStringSlice(path string, value []string) error

+ func (c *ConfigFileTypedWrapper) SetUint(path string, value uint) error

+ func (c *ConfigFileTypedWrapper) SetUint16(path string, value uint16) error

+ func (c *ConfigFileTypedWrapper) SetUint16Slice(path string, value []uint16) error

+ func (c *ConfigFileTypedWrapper) SetUint32(path string, value uint32) error

+ func (c *ConfigFileTypedWrapper) SetUint32Slice(path string, value []uint32) error

+ func (c *ConfigFileTypedWrapper) SetUint64(path string, value uint64) error

+ func (c *ConfigFileTypedWrapper) SetUint64Slice(path string, value []uint64) error

+ func (c *ConfigFileTypedWrapper) SetUint8(path string, value uint8) error

+ func (c *ConfigFileTypedWrapper) SetUint8Slice(path string, value []uint8) error

+ func (c *ConfigFileTypedWrapper) SetUintSlice(path string, value []uint) error

+ func (w *ConfigFileTypedWrapper) DeleteKey(path string) error

+ func (w *ConfigFileTypedWrapper) FileUsed() string

+ func (w *ConfigFileTypedWrapper) GetKeys(path string) []string

+ func (w *ConfigFileTypedWrapper) GetValue(path string) (any, bool)

+ func (w *ConfigFileTypedWrapper) OnChange(h ConfigFileChangeHandler) error

+ func (w *ConfigFileTypedWrapper) Save() error

+ func (w *ConfigFileTypedWrapper) SetValue(path string, v any) error

+ type ConfigFileUnmarshal func(data []byte, v any) error

+ type Flag interface

+ type FlagTyped struct

+ Aliases []string

+ AssignTo *T

+ ConfigPath []string

+ DefaultText string

+ DefaultValue T

+ EnvVars []string

+ Global bool

+ Hidden bool

+ HideDefault bool

+ HideType bool

+ Name string

+ Required bool

+ Usage string

+ ValidateFlag func(*Command) error

+ type Float32Arg = ArgumentTyped[float32]

+ type Float32Flag = FlagTyped[float32]

+ type Float32SliceFlag = FlagTyped[[]float32]

+ type Float64Arg = ArgumentTyped[float64]

+ type Float64Flag = FlagTyped[float64]

+ type Float64SliceFlag = FlagTyped[[]float64]

+ type Int16Arg = ArgumentTyped[int16]

+ type Int16Flag = FlagTyped[int16]

+ type Int16SliceFlag = FlagTyped[[]int16]

+ type Int32Arg = ArgumentTyped[int32]

+ type Int32Flag = FlagTyped[int32]

+ type Int32SliceFlag = FlagTyped[[]int32]

+ type Int64Arg = ArgumentTyped[int64]

+ type Int64Flag = FlagTyped[int64]

+ type Int64SliceFlag = FlagTyped[[]int64]

+ type Int8Arg = ArgumentTyped[int8]

+ type Int8Flag = FlagTyped[int8]

+ type Int8SliceFlag = FlagTyped[[]int8]

+ type IntArg = ArgumentTyped[int]

+ type IntFlag = FlagTyped[int]

+ type IntSliceFlag = FlagTyped[[]int]

+ type SearchPathFunc func() []string

+ type StringArg = ArgumentTyped[string]

+ type StringFlag = FlagTyped[string]

+ type StringSliceFlag = FlagTyped[[]string]

+ type Uint16Arg = ArgumentTyped[uint16]

+ type Uint16Flag = FlagTyped[uint16]

+ type Uint16SliceFlag = FlagTyped[[]uint16]

+ type Uint32Arg = ArgumentTyped[uint32]

+ type Uint32Flag = FlagTyped[uint32]

+ type Uint32SliceFlag = FlagTyped[[]uint32]

+ type Uint64Arg = ArgumentTyped[uint64]

+ type Uint64Flag = FlagTyped[uint64]

+ type Uint64SliceFlag = FlagTyped[[]uint64]

+ type Uint8Arg = ArgumentTyped[uint8]

+ type Uint8Flag = FlagTyped[uint8]

+ type Uint8SliceFlag = FlagTyped[[]uint8]

+ type UintArg = ArgumentTyped[uint]

+ type UintFlag = FlagTyped[uint]

+ type UintSliceFlag = FlagTyped[[]uint]

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