command

Jul 20, 2026

Changes in this version

type C

+ func InfoCommand(name string) *C

Jul 6, 2026

Changes in this version

type FlagInfo

+ IsBool bool

May 21, 2026

Changes in this version

type FlagInfo

+ Private bool

Apr 26, 2026

retracted

Changes in this version

type Env

+ func (e *Env) ParseFlags() error

Apr 8, 2026

Changes in this version

type Env

+ func (e *Env) IsFlagSet(name string) bool

Aug 13, 2025

Changes in this version

type C

+ func (c *C) Info(flags HelpFlags) *CInfo

+ type CInfo struct

+ Commands []*CInfo

+ Flags []FlagInfo

+ Help string

+ Name string

+ Runnable bool

+ Unlisted bool

+ Usage []string

+ type FlagInfo struct

+ DefaultString string

+ Name string

+ Usage string

type HelpFlags

+ const IncludeAll

Jan 11, 2025

Changes in this version

type VersionInfo

+ BuildTags []string

Nov 14, 2024

Changes in this version

+ type PanicError struct

+ func (p PanicError) Env() *Env

+ func (p PanicError) Error() string

+ func (p PanicError) Stack() string

+ func (p PanicError) Value() any

Nov 11, 2024

Changes in this version

+ var ErrRunPanicked = errors.New("run panicked")

Mar 10, 2024

Changes in this version

+ func ProgramName() string

Feb 16, 2024

Changes in this version

type VersionInfo

+ BinaryPath string

+ ImportPath string

Feb 10, 2024

Changes in this version

+ type VersionInfo struct

+ Arch string

+ Commit string

+ Modified bool

+ Name string

+ OS string

+ Path string

+ Time *time.Time

+ Toolchain string

+ Version string

+ func GetVersionInfo() VersionInfo

+ func (v VersionInfo) String() string

Oct 24, 2023

Changes in this version

type Env

+ func (e *Env) HelpFlags(f HelpFlags) *Env

Aug 25, 2023

Changes in this version

type C

+ Unlisted bool

type Env

+ func (e *Env) MergeFlags(merge bool) *Env

+ type HelpFlags int

+ const IncludeCommands

+ const IncludePrivateFlags

+ const IncludeUnlisted

Aug 20, 2023

Changes in this version

+ func Flags(bind func(*flag.FlagSet, any), v any) func(*Env, *flag.FlagSet)

Aug 20, 2023

Changes in this version

+ func Adapt(fn any) func(*Env) error

Aug 8, 2023

Changes in this version

+ func MergeFlags(env *Env)

May 23, 2023

Changes in this version

type Env

+ func (e *Env) Cancel(cause error)

+ func (e *Env) Context() context.Context

+ func (e *Env) SetContext(ctx context.Context) *Env

May 5, 2023

Changes in this version

+ var ErrRequestHelp = errors.New("help requested")

+ func FailWithUsage(env *Env) error

+ func Run(env *Env, rawArgs []string) error

+ func RunHelp(env *Env) error

+ func RunOrFail(env *Env, rawArgs []string)

+ type C struct

+ Commands []*C

+ CustomFlags bool

+ Flags flag.FlagSet

+ Help string

+ Init func(env *Env) error

+ Name string

+ Run func(env *Env) error

+ SetFlags func(env *Env, fs *flag.FlagSet)

+ Usage string

+ func HelpCommand(topics []HelpTopic) *C

+ func VersionCommand() *C

+ func (c *C) FindSubcommand(name string) *C

+ func (c *C) HasRunnableSubcommands() bool

+ func (c *C) HelpInfo(includeCommands bool) HelpInfo

+ func (c *C) NewEnv(config any) *Env

+ func (c *C) Runnable() bool

+ type Env struct

+ Args []string

+ Command *C

+ Config any

+ Log io.Writer

+ Parent *Env

+ func (e *Env) Usagef(msg string, args ...any) error

+ func (e *Env) Write(data []byte) (int, error)

+ type HelpInfo struct

+ Commands []HelpInfo

+ Flags string

+ Help string

+ Name string

+ Synopsis string

+ Topics []HelpInfo

+ Usage string

+ func (h HelpInfo) WriteLong(w io.Writer)

+ func (h HelpInfo) WriteSynopsis(w io.Writer)

+ func (h HelpInfo) WriteUsage(w io.Writer)

+ type HelpTopic struct

+ Help string

+ Name string

+ type UsageError struct

+ Env *Env

+ Message string

+ func (u UsageError) Error() string