cli

Nov 1, 2022

Changes in this version

type CLI

+ func NewCLI() *CLI

+ type UsageErrorWrapper struct

+ Err error

+ func UsageError(err error) UsageErrorWrapper

+ func UsageErrorf(format string, v ...interface{}) UsageErrorWrapper

+ func (w UsageErrorWrapper) Error() string

+ func (w UsageErrorWrapper) Unwrap() error

Oct 23, 2022

Changes in this version

type Command

+ func (cmd *Command) Apply(parent *Command)

+ func (cmd *Command) SetDescription(description string) *Command

+ type CommandOption interface

+ Apply func(cmd *Command)

+ func WithDescription(description string) CommandOption

+ func WithHelp(help string) CommandOption

Aug 3, 2022

Changes in this version

type CLI

+ HelpWriter io.Writer

Aug 3, 2022

Changes in this version

+ var Defaults = CLI

+ func ContextWithSigCancel(ctx context.Context) (context.Context, context.CancelFunc)

+ type CLI struct

+ ErrWriter io.Writer

+ LookupEnv LookupEnvFunc

+ Setter SetterFunc

+ func (cli CLI) Build(name string, config interface{}) (*Command, error)

+ func (cli CLI) New(name string, config interface{}) *Command

+ type ContextRunner interface

+ Run func(context.Context) error

+ type ExitCoder interface

+ ExitCode func() int

+ type ParseResult struct

+ Command *Command

+ Err error

+ func (po ParseResult) Run() error

+ func (po ParseResult) RunFatal()

+ func (po ParseResult) RunFatalWithContext(ctx context.Context)

+ func (po ParseResult) RunFatalWithSigCancel()

+ func (po ParseResult) RunWithContext(ctx context.Context) error

+ func (po ParseResult) RunWithSigCancel() error

+ type RunFunc func(context.Context) error

Jul 18, 2022

Changes in this version

type Context

+ Setter SetterFunc

+ type Setter interface

+ Set func(s string) error

+ type SetterFunc func(interface{}) Setter

Jul 13, 2022

Changes in this version

+ var DefaultContext = Context

type Command

+ func (cmd *Command) Description(description string) *Command

+ type Context struct

+ ErrWriter io.Writer

+ LookupEnv LookupEnvFunc

+ func (ctx Context) Build(name string, config interface{}) (*Command, error)

+ func (ctx Context) New(name string, config interface{}) *Command

+ type LookupEnvFunc func(string) (string, bool, error)

+ type Setuper interface

+ SetupCommand func(cmd *Command)

Jun 30, 2022

Changes in this version

+ func SetEnvVarMiddleware(h EnvVarHandler)

+ type EnvVarHandler func(string) (string, error)

Jun 29, 2022

Changes in this version

+ var ErrHelp = fmt.Errorf("cli: help requested")

+ type Beforer interface

+ Before func() error

+ type Command struct

+ Help string

+ Name string

+ ShortHelp string

+ ShortName string

+ func Build(name string, config interface{}) (*Command, error)

+ func New(name string, config interface{}) *Command

+ func (cmd *Command) AddCommand(subCmd *Command) *Command

+ func (cmd *Command) AddCommands(cmds []*Command) *Command

+ func (cmd *Command) HelpString() string

+ func (cmd *Command) Parse() ParsedCommand

+ func (cmd *Command) ParseArgs(args []string) ParsedCommand

+ func (cmd *Command) SetHelp(help string) *Command

+ func (cmd *Command) SetShortHelp(help string) *Command

+ func (cmd *Command) SetShortName(shortName string) *Command

+ func (cmd *Command) WriteHelp(w io.Writer)

+ type ParsedCommand struct

+ Command *Command

+ Err error

+ Runner Runner

+ func (po ParsedCommand) Run() error

+ func (po ParsedCommand) RunFatal()

+ type Runner interface

+ Run func() error