console

package module

Go to main page

Versions in this module

v1

v1.2.3

Nov 28, 2025

v1.2.2

Sep 30, 2025

Changes in this version

type Application

+ func (a *Application) MustRun(arguments []string)

v1.2.1

Feb 20, 2025

v1.2.0

Feb 17, 2025

v1.1.5

Aug 27, 2024

v1.1.4

Jul 1, 2024

Changes in this version

+ func GuessShell() string — darwin/amd64, linux/amd64

v1.1.3

Jun 14, 2024

v1.1.2

Jun 14, 2024

Changes in this version

+ var CompletionTemplates embed.FS — darwin/amd64, linux/amd64

v1.1.1

Jun 14, 2024

v1.1.0

Jun 12, 2024

Changes in this version

+ const HasAutocompleteSupport — js/wasm, windows/amd64

+ const SupportsAutocomplete — darwin/amd64, linux/amd64

+ func AutocompleteAppAction(c *Context) error — darwin/amd64, linux/amd64

+ func CurrentBinaryInvocation() (string, error)

+ func IsAutocomplete(c *Command) bool

+ func IsGoRun() bool

type BoolFlag

+ ArgsPredictor func(*Context, string) []string

+ func (f *BoolFlag) PredictArgs(c *Context, prefix string) []string

type Command — darwin/amd64, linux/amd64

+ DescriptionFunc DescriptionFunc

+ ShellComplete ShellCompleteFunc

+ func (c *Command) PredictArgs(ctx *Context, prefix string) []string

type Context

+ func (c *Context) CurrentBinaryInvocation() string

+ func (c *Context) CurrentBinaryPath() string

+ type ContextPredictor struct — darwin/amd64, linux/amd64

+ func (p ContextPredictor) Predict(prefix string) []string

+ type DescriptionFunc func(*Command, *Application) string

type DurationFlag

+ ArgsPredictor func(*Context, string) []string

+ func (f *DurationFlag) PredictArgs(c *Context, prefix string) []string

type Flag

+ PredictArgs func(*Context, string) []string

type Float64Flag

+ ArgsPredictor func(*Context, string) []string

+ func (f *Float64Flag) PredictArgs(c *Context, prefix string) []string

type Float64SliceFlag

+ ArgsPredictor func(*Context, string) []string

+ func (f *Float64SliceFlag) PredictArgs(c *Context, prefix string) []string

type GenericFlag

+ ArgsPredictor func(*Context, string) []string

+ func (f *GenericFlag) PredictArgs(c *Context, prefix string) []string

type Int64Flag

+ ArgsPredictor func(*Context, string) []string

+ func (f *Int64Flag) PredictArgs(c *Context, prefix string) []string

type Int64SliceFlag

+ ArgsPredictor func(*Context, string) []string

+ func (f *Int64SliceFlag) PredictArgs(c *Context, prefix string) []string

type IntFlag

+ ArgsPredictor func(*Context, string) []string

+ func (f *IntFlag) PredictArgs(c *Context, prefix string) []string

type IntSliceFlag

+ ArgsPredictor func(*Context, string) []string

+ func (f *IntSliceFlag) PredictArgs(c *Context, prefix string) []string

+ type Predictor interface — darwin/amd64, linux/amd64

+ PredictArgs func(*Context, string) []string

+ type ShellCompleteFunc func(*Context, string) []string

type StringFlag

+ ArgsPredictor func(*Context, string) []string

+ func (f *StringFlag) PredictArgs(c *Context, prefix string) []string

type StringMapFlag

+ ArgsPredictor func(*Context, string) []string

+ func (f *StringMapFlag) PredictArgs(c *Context, prefix string) []string

type StringSliceFlag

+ ArgsPredictor func(*Context, string) []string

+ func (f *StringSliceFlag) PredictArgs(c *Context, prefix string) []string

type Uint64Flag

+ ArgsPredictor func(*Context, string) []string

+ func (f *Uint64Flag) PredictArgs(c *Context, prefix string) []string

type UintFlag

+ ArgsPredictor func(*Context, string) []string

+ func (f *UintFlag) PredictArgs(c *Context, prefix string) []string

v1.0.5

May 5, 2024

v1.0.4

Apr 16, 2024

v1.0.3

Feb 22, 2023

Changes in this version

type Application

+ func (a *Application) BestCommand(name string) *Command

v1.0.2

Apr 22, 2022

v1.0.1

Jan 1, 2022

v1.0.0

Nov 13, 2021

Changes in this version

+ var AnsiFlag = &BoolFlag

+ var AppHelpTemplate = ...

+ var CategoryHelpTemplate = ...

+ var CommandHelpTemplate = ...

+ var HelpFlag = &BoolFlag

+ var HelpPrinter helpPrinter = printHelp

+ var LogLevelFlag = VerbosityFlag("log-level", "verbose", "v")

+ var NoAnsiFlag = &BoolFlag

+ var NoInteractionFlag = &BoolFlag

+ var OsExiter = os.Exit

+ var QuietFlag = newQuietFlag("quiet", "q")

+ var VersionFlag = &BoolFlag

+ var VersionPrinter = printVersion

+ func CurrentBinaryName() string

+ func CurrentBinaryPath() (string, error)

+ func ExpandHome(path string) string

+ func FormatErrorChain(buf *bytes.Buffer, err error, trimPaths bool) bool

+ func HandleError(err error)

+ func HandleExitCoder(err error)

+ func Hide() bool

+ func IsHelp(c *Context) bool

+ func ShowAppHelp(c *Context) error

+ func ShowAppHelpAction(c *Context) error

+ func ShowCommandHelp(ctx *Context, command string) error

+ func ShowVersion(c *Context)

+ func VerbosityFlag(name, alias, shortAlias string) *verbosityFlag

+ func WrapPanic(msg interface{}) error

+ type ActionFunc func(*Context) error

+ type AfterFunc func(*Context) error

+ type Alias struct

+ Hidden bool

+ Name string

+ func (a *Alias) String() string

+ type Application struct

+ Action ActionFunc

+ After AfterFunc

+ Before BeforeFunc

+ BuildDate string

+ Categories CommandCategories

+ Channel string

+ Commands []*Command

+ Copyright string

+ Description string

+ ErrWriter io.Writer

+ FlagEnvPrefix []string

+ Flags []Flag

+ HelpName string

+ Name string

+ Usage string

+ Version string

+ Writer io.Writer

+ func (a *Application) Category(name string) *CommandCategory

+ func (a *Application) Command(name string) *Command

+ func (a *Application) Run(arguments []string) (err error)

+ func (a *Application) VisibleCategories() []CommandCategory

+ func (a *Application) VisibleCommands() []*Command

+ func (a *Application) VisibleFlags() []Flag

+ type Arg struct

+ Default string

+ Description string

+ Name string

+ Optional bool

+ Slice bool

+ func (a *Arg) String() string

+ type ArgDefinition []*Arg

+ func (def ArgDefinition) Usage() string

+ type Args interface

+ Get func(name string) string

+ Len func() int

+ Present func() bool

+ Slice func() []string

+ Tail func() []string

+ type BeforeFunc func(*Context) error

+ type BoolFlag struct

+ Aliases []string

+ DefaultText string

+ DefaultValue bool

+ Destination *bool

+ EnvVars []string

+ Hidden bool

+ Name string

+ Required bool

+ Usage string

+ Validator func(*Context, bool) error

+ func (f *BoolFlag) Apply(set *flag.FlagSet)

+ func (f *BoolFlag) Names() []string

+ func (f *BoolFlag) String() string

+ func (f *BoolFlag) Validate(c *Context) error

+ type Command struct

+ Action ActionFunc

+ After AfterFunc

+ Aliases []*Alias

+ Args ArgDefinition

+ Before BeforeFunc

+ Category string

+ Description string

+ FlagParsing FlagParsingMode

+ Flags []Flag

+ HelpName string

+ Hidden func() bool

+ Name string

+ Usage string

+ UserName string

+ func (c *Command) Arguments() ArgDefinition

+ func (c *Command) FullName() string

+ func (c *Command) HasName(name string, exact bool) bool

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

+ func (c *Command) PreferredName() string

+ func (c *Command) Run(ctx *Context) (err error)

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

+ type CommandCategories interface

+ AddCommand func(category string, command *Command)

+ Categories func() []CommandCategory

+ type CommandCategory interface

+ Name func() string

+ VisibleCommands func() []*Command

+ type CommandNotFoundError struct

+ func (e *CommandNotFoundError) Error() string

+ func (e *CommandNotFoundError) ExitCode() int

+ func (e *CommandNotFoundError) GetSeverity() zerolog.Level

+ type CommandNotFoundFunc func(*Context, string) error

+ type Context struct

+ App *Application

+ Command *Command

+ func NewContext(app *Application, set *flag.FlagSet, parentCtx *Context) *Context

+ func (c *Context) Args() Args

+ func (c *Context) Bool(name string) bool

+ func (c *Context) Duration(name string) time.Duration

+ func (c *Context) Float64(name string) float64

+ func (c *Context) Float64Slice(name string) []float64

+ func (c *Context) Generic(name string) interface{}

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

+ func (c *Context) Int(name string) int

+ func (c *Context) Int64(name string) int64

+ func (c *Context) Int64Slice(name string) []int64

+ func (c *Context) IntSlice(name string) []int

+ func (c *Context) IsSet(name string) bool

+ func (c *Context) Lineage() []*Context

+ func (c *Context) NArg() int

+ func (c *Context) Set(name, value string) error

+ func (c *Context) String(name string) string

+ func (c *Context) StringMap(name string) map[string]string

+ func (c *Context) StringSlice(name string) []string

+ func (c *Context) Uint(name string) uint

+ func (c *Context) Uint64(name string) uint64

+ type DurationFlag struct

+ Aliases []string

+ DefaultText string

+ DefaultValue time.Duration

+ Destination *time.Duration

+ EnvVars []string

+ Hidden bool

+ Name string

+ Required bool

+ Usage string

+ Validator func(*Context, time.Duration) error

+ func (f *DurationFlag) Apply(set *flag.FlagSet)

+ func (f *DurationFlag) Names() []string

+ func (f *DurationFlag) String() string

+ func (f *DurationFlag) Validate(c *Context) error

+ type ExitCoder interface

+ ExitCode func() int

+ func Exit(message string, exitCode int) ExitCoder

+ type Flag interface

+ Apply func(*flag.FlagSet)

+ Names func() []string

+ Validate func(*Context) error

+ type FlagParsingMode int

+ const FlagParsingNormal

+ const FlagParsingSkipped

+ const FlagParsingSkippedAfterFirstArg

+ func (mode FlagParsingMode) IsPostfix() bool

+ func (mode FlagParsingMode) IsPrefix() bool

+ 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 Float64Flag struct

+ Aliases []string

+ DefaultText string

+ DefaultValue float64

+ Destination *float64

+ EnvVars []string

+ Hidden bool

+ Name string

+ Required bool

+ Usage string

+ Validator func(*Context, float64) error

+ func (f *Float64Flag) Apply(set *flag.FlagSet)

+ func (f *Float64Flag) Names() []string

+ func (f *Float64Flag) String() string

+ func (f *Float64Flag) Validate(c *Context) error

+ type Float64Slice struct

+ func NewFloat64Slice(defaults ...float64) *Float64Slice

+ func (f *Float64Slice) Serialized() string

+ func (f *Float64Slice) Set(value string) error

+ func (f *Float64Slice) String() string

+ func (f *Float64Slice) Value() []float64

+ type Float64SliceFlag struct

+ Aliases []string

+ DefaultText string

+ Destination *Float64Slice

+ EnvVars []string

+ Hidden bool

+ Name string

+ Required bool

+ Usage string

+ Validator func(*Context, []float64) error

+ func (f *Float64SliceFlag) Apply(set *flag.FlagSet)

+ func (f *Float64SliceFlag) Names() []string

+ func (f *Float64SliceFlag) String() string

+ func (f *Float64SliceFlag) Validate(c *Context) error

+ type Generic interface

+ Set func(value string) error

+ String func() string

+ type GenericFlag struct

+ Aliases []string

+ DefaultText string

+ Destination Generic

+ EnvVars []string

+ Hidden bool

+ Name string

+ Required bool

+ Usage string

+ Validator func(*Context, interface{}) error

+ func (f *GenericFlag) Apply(set *flag.FlagSet)

+ func (f *GenericFlag) Names() []string

+ func (f *GenericFlag) String() string

+ func (f *GenericFlag) Validate(c *Context) error

+ type IncorrectUsageError struct

+ ParentError error

+ func (e IncorrectUsageError) Cause() error

+ func (e IncorrectUsageError) Error() string

+ type Int64Flag struct

+ Aliases []string

+ DefaultText string

+ DefaultValue int64

+ Destination *int64

+ EnvVars []string

+ Hidden bool

+ Name string

+ Required bool

+ Usage string

+ Validator func(*Context, int64) error

+ func (f *Int64Flag) Apply(set *flag.FlagSet)

+ func (f *Int64Flag) Names() []string

+ func (f *Int64Flag) String() string

+ func (f *Int64Flag) Validate(c *Context) error

+ type Int64Slice struct

+ func NewInt64Slice(defaults ...int64) *Int64Slice

+ func (f *Int64Slice) Serialized() string

+ func (f *Int64Slice) Set(value string) error

+ func (f *Int64Slice) String() string

+ func (f *Int64Slice) Value() []int64

+ type Int64SliceFlag struct

+ Aliases []string

+ DefaultText string

+ Destination *Int64Slice

+ EnvVars []string

+ Hidden bool

+ Name string

+ Required bool

+ Usage string

+ Validator func(*Context, []int64) error

+ func (f *Int64SliceFlag) Apply(set *flag.FlagSet)

+ func (f *Int64SliceFlag) Names() []string

+ func (f *Int64SliceFlag) String() string

+ func (f *Int64SliceFlag) Validate(c *Context) error

+ type IntFlag struct

+ Aliases []string

+ DefaultText string

+ DefaultValue int

+ Destination *int

+ EnvVars []string

+ Hidden bool

+ Name string

+ Required bool

+ Usage string

+ Validator func(*Context, int) error

+ func (f *IntFlag) Apply(set *flag.FlagSet)

+ func (f *IntFlag) Names() []string

+ func (f *IntFlag) String() string

+ func (f *IntFlag) Validate(c *Context) error

+ type IntSlice struct

+ func NewIntSlice(defaults ...int) *IntSlice

+ func (i *IntSlice) Serialized() string

+ func (i *IntSlice) Set(value string) error

+ func (i *IntSlice) SetInt(value int)

+ func (i *IntSlice) String() string

+ func (i *IntSlice) Value() []int

+ type IntSliceFlag struct

+ Aliases []string

+ DefaultText string

+ Destination *IntSlice

+ EnvVars []string

+ Hidden bool

+ Name string

+ Required bool

+ Usage string

+ Validator func(*Context, []int) error

+ func (f *IntSliceFlag) Apply(set *flag.FlagSet)

+ func (f *IntSliceFlag) Names() []string

+ func (f *IntSliceFlag) String() string

+ func (f *IntSliceFlag) Validate(c *Context) error

+ type MultiError interface

+ Errors func() []error

+ type Serializeder interface

+ Serialized func() string

+ type StringFlag struct

+ Aliases []string

+ DefaultText string

+ DefaultValue string

+ Destination *string

+ EnvVars []string

+ Hidden bool

+ Name string

+ Required bool

+ Usage string

+ Validator func(*Context, string) error

+ func (f *StringFlag) Apply(set *flag.FlagSet)

+ func (f *StringFlag) Names() []string

+ func (f *StringFlag) String() string

+ func (f *StringFlag) Validate(c *Context) error

+ type StringMap struct

+ func NewStringMap(m map[string]string) *StringMap

+ func (m *StringMap) Serialized() string

+ func (m *StringMap) Set(value string) error

+ func (m *StringMap) String() string

+ func (m *StringMap) Value() map[string]string

+ type StringMapFlag struct

+ Aliases []string

+ DefaultText string

+ Destination *StringMap

+ EnvVars []string

+ Hidden bool

+ Name string

+ Required bool

+ Usage string

+ Validator func(*Context, map[string]string) error

+ func (f *StringMapFlag) Apply(set *flag.FlagSet)

+ func (f *StringMapFlag) Names() []string

+ func (f *StringMapFlag) String() string

+ func (f *StringMapFlag) Validate(c *Context) error

+ type StringSlice struct

+ func NewStringSlice(defaults ...string) *StringSlice

+ func (f *StringSlice) Serialized() string

+ func (f *StringSlice) Set(value string) error

+ func (f *StringSlice) String() string

+ func (f *StringSlice) Value() []string

+ type StringSliceFlag struct

+ Aliases []string

+ DefaultText string

+ Destination *StringSlice

+ EnvVars []string

+ Hidden bool

+ Name string

+ Required bool

+ Usage string

+ Validator func(*Context, []string) error

+ func (f *StringSliceFlag) Apply(set *flag.FlagSet)

+ func (f *StringSliceFlag) Names() []string

+ func (f *StringSliceFlag) String() string

+ func (f *StringSliceFlag) Validate(c *Context) error

+ type Uint64Flag struct

+ Aliases []string

+ DefaultText string

+ DefaultValue uint64

+ Destination *uint64

+ EnvVars []string

+ Hidden bool

+ Name string

+ Required bool

+ Usage string

+ Validator func(*Context, uint64) error

+ func (f *Uint64Flag) Apply(set *flag.FlagSet)

+ func (f *Uint64Flag) Names() []string

+ func (f *Uint64Flag) String() string

+ func (f *Uint64Flag) Validate(c *Context) error

+ type UintFlag struct

+ Aliases []string

+ DefaultText string

+ DefaultValue uint

+ Destination *uint

+ EnvVars []string

+ Hidden bool

+ Name string

+ Required bool

+ Usage string

+ Validator func(*Context, uint) error

+ func (f *UintFlag) Apply(set *flag.FlagSet)

+ func (f *UintFlag) Names() []string

+ func (f *UintFlag) String() string

+ func (f *UintFlag) Validate(c *Context) error

+ type WrappedPanic struct

+ func (p WrappedPanic) Cause() error

+ func (p WrappedPanic) Error() string

+ func (p WrappedPanic) StackTrace() errors.StackTrace

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