cli

package module

Go to main page

Versions in this module

v0

v0.6.0

Jan 18, 2026

Changes in this version

+ var HelpMsgTextWidth = 90

+ var HelpShortMsgMaxFirstColLen = 24

type CommandInfo

+ IsSubcmdOptional bool

+ func (c CommandInfo) SubcmdOptional() CommandInfo

type MissingArgsError

+ CmdInfo *CommandInfo

type MissingOptionValueError

+ CmdInfo *CommandInfo

type MissingOptionsError

+ CmdInfo *CommandInfo

type UnknownOptionError

+ CmdInfo *CommandInfo

type UnknownSubcmdError

+ CmdInfo *CommandInfo

v0.5.0

Aug 11, 2025

Changes in this version

+ var DefaultVersionOpt = NewVersionOpt('v', "version", VersionOptConfig{ ... })

+ func Fatal(code int, v any)

type CommandInfo

+ func (in *CommandInfo) ParseThese(args ...string) (*Command, error)

+ func (in CommandInfo) ParseTheseOrExit(args ...string) *Command

+ type HelpOrVersionRequested struct

+ Msg string

+ func (h HelpOrVersionRequested) Error() string

type InputInfo

+ Versioner Versioner

+ func NewVersionOpt(short byte, long string, cfg VersionOptConfig) InputInfo

+ func (in InputInfo) WithVersioner(ver Versioner) InputInfo

+ type VersionOptConfig struct

+ HelpBlurb string

+ IncludeGoVersion bool

+ type Versioner = func(Input) string

v0.4.0

Jun 30, 2025

v0.3.0

Jun 19, 2025

Changes in this version

+ func GetAllSeq[T any](c *Command, id string) iter.Seq[T]

+ func GetAll[T any](c *Command, id string) []T

+ func GetOrFunc[T any](c *Command, id string, fn func() T) T

type CommandInfo

+ func New(name ...string) CommandInfo

v0.2.0

May 27, 2025

Changes in this version

+ var DefaultHelpInput = ...(DefaultHelpGenerator)

+ var ErrNoSubcmd = errors.New("missing subcommand")

+ func DefaultFullHelp(c *CommandInfo) string

+ func DefaultHelpGenerator(src Input, c *CommandInfo) string

+ func DefaultShortHelp(c *CommandInfo) string

+ func GetOr[T any](c *Command, id string, fallback T) T

+ func Get[T any](c *Command, id string) T

+ func Lookup[T any](c *Command, id string) (T, bool)

+ func ParseBool(s string) (any, error)

+ func ParseDuration(s string) (any, error)

+ func ParseFloat32(s string) (any, error)

+ func ParseFloat64(s string) (any, error)

+ func ParseInt(s string) (any, error)

+ func ParseURL(s string) (any, error)

+ func ParseUint(s string) (any, error)

+ type Command struct

+ Inputs []Input

+ Name string

+ Subcmd *Command

+ Surplus []string

+ type CommandInfo struct

+ Args []InputInfo

+ HelpBlurb string

+ HelpExtra string

+ HelpUsage []string

+ Name string

+ Opts []InputInfo

+ Path []string

+ Subcmds []CommandInfo

+ func NewCmd(name string) CommandInfo

+ func (c CommandInfo) Arg(a InputInfo) CommandInfo

+ func (c CommandInfo) ExtraHelp(extra string) CommandInfo

+ func (c CommandInfo) Help(blurb string) CommandInfo

+ func (c CommandInfo) Opt(o InputInfo) CommandInfo

+ func (c CommandInfo) Subcmd(sc CommandInfo) CommandInfo

+ func (c CommandInfo) Usage(lines ...string) CommandInfo

+ func (in *CommandInfo) Parse(args ...string) (*Command, error)

+ func (in CommandInfo) ParseOrExit(args ...string) *Command

+ type HelpGenerator = func(Input, *CommandInfo) string

+ type HelpRequestError struct

+ HelpMsg string

+ func (h HelpRequestError) Error() string

+ type Input struct

+ From ParsedFrom

+ ID string

+ RawValue string

+ Value any

+ type InputInfo struct

+ EnvVar string

+ HasStrDefault bool

+ HelpBlurb string

+ HelpGen HelpGenerator

+ ID string

+ IsBoolOpt bool

+ IsRequired bool

+ NameLong string

+ NameShort string

+ StrDefault string

+ ValueName string

+ ValueParser ValueParser

+ func NewArg(id string) InputInfo

+ func NewBoolOpt(id string) InputInfo

+ func NewFloat32Opt(id string) InputInfo

+ func NewFloat64Opt(id string) InputInfo

+ func NewIntOpt(id string) InputInfo

+ func NewOpt(id string) InputInfo

+ func NewUintOpt(id string) InputInfo

+ func (in InputInfo) Default(v string) InputInfo

+ func (in InputInfo) Env(e string) InputInfo

+ func (in InputInfo) Help(blurb string) InputInfo

+ func (in InputInfo) Long(name string) InputInfo

+ func (in InputInfo) Required() InputInfo

+ func (in InputInfo) Short(c byte) InputInfo

+ func (in InputInfo) ShortOnly(c byte) InputInfo

+ func (in InputInfo) WithHelpGen(hg HelpGenerator) InputInfo

+ func (in InputInfo) WithParser(vp ValueParser) InputInfo

+ func (in InputInfo) WithValueName(name string) InputInfo

+ type MissingArgsError struct

+ Names []string

+ func (mae MissingArgsError) Error() string

+ func (mae MissingArgsError) Is(err error) bool

+ type MissingOptionValueError struct

+ Name string

+ func (mov MissingOptionValueError) Error() string

+ type MissingOptionsError struct

+ Names []string

+ func (moe MissingOptionsError) Error() string

+ func (moe MissingOptionsError) Is(err error) bool

+ type ParsedFrom struct

+ Arg int

+ Default bool

+ Env string

+ Opt string

+ type UnknownOptionError struct

+ Name string

+ func (uoe UnknownOptionError) Error() string

+ type UnknownSubcmdError struct

+ Name string

+ func (usce UnknownSubcmdError) Error() string

+ type ValueParser = func(string) (any, error)

+ func NewFileParser(vp ValueParser) ValueParser

+ func NewTimeParser(layout string) ValueParser

v0.1.0-beta

May 18, 2025

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