cliz

Jan 12, 2024

Changes in this version

type Command

+ Short string

+ func (cmd *Command) IsCommand(cmdName string) bool

Nov 11, 2023

Changes in this version

+ var ErrCommandFuncNotSet = errors.New("command func not set")

+ var ErrCommandNotSetInContext = errors.New("command not set in context")

+ var ErrOptionRequired = errors.New("option required")

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

type BoolOption

+ func (o *BoolOption) HasValue() bool

type Command

+ RunFunc func(ctx context.Context, remainingArgs []string) error

+ UsageFunc func(c *Command)

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

+ func (cmd *Command) GetCalledCommands() []string

+ func (cmd *Command) GetName() string

+ func (cmd *Command) GetOptionBool(name string) (bool, error)

+ func (cmd *Command) GetOptionFloat64(name string) (float64, error)

+ func (cmd *Command) GetOptionInt(name string) (int, error)

+ func (cmd *Command) GetOptionString(name string) (string, error)

+ func (cmd *Command) Next() *Command

+ func (cmd *Command) Run(ctx context.Context, args []string) error

+ func (cmd *Command) ShowUsage()

+ type Float64Option struct

+ Default *float64

+ Description string

+ Environment string

+ Name string

+ Short string

+ func (o *Float64Option) GetDescription() string

+ func (o *Float64Option) GetEnvironment() string

+ func (o *Float64Option) GetName() string

+ func (o *Float64Option) GetShort() string

+ func (o *Float64Option) HasDefault() bool

+ func (o *Float64Option) HasValue() bool

type IntOption

+ func (o *IntOption) HasValue() bool

type Option

+ HasValue func() bool

type StringOption

+ func (o *StringOption) HasValue() bool

Nov 1, 2023

Changes in this version

+ const HelpOptionName

+ const UTIL_GO_CLI_DEBUG

+ const UTIL_GO_CLI_TRACE

+ var DebugLog = newLogger(Stderr, UTIL_GO_CLI_DEBUG, "DEBUG: ")

+ var ErrDuplicateOptionName = errors.New("duplicate option name")

+ var ErrDuplicateSubCommand = errors.New("duplicate sub command")

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

+ var ErrInvalidOptionType = errors.New("invalid option type")

+ var ErrMissingOptionValue = errors.New("missing option value")

+ var ErrMultipleOptionsDefaultValue = errors.New(...)

+ var ErrNoOption = errors.New("no option")

+ var ErrUnexpectedError = errors.New("unexpected error")

+ var ErrUnknownOption = errors.New("unknown option")

+ var Stderr io.Writer = os.Stderr

+ var Stdout io.Writer = os.Stdout

+ var TraceLog = newLogger(Stderr, UTIL_GO_CLI_TRACE, "TRACE: ")

+ func Default(v T) *T

+ func IsHelp(err error) bool

+ type BoolOption struct

+ Default *bool

+ Description string

+ Environment string

+ Name string

+ Short string

+ func (o *BoolOption) GetDescription() string

+ func (o *BoolOption) GetEnvironment() string

+ func (o *BoolOption) GetName() string

+ func (o *BoolOption) GetShort() string

+ func (o *BoolOption) HasDefault() bool

+ type Command struct

+ Description string

+ Name string

+ Options []Option

+ SubCommands []*Command

+ Usage func(c *Command)

+ func (cmd *Command) GetBoolOption(name string) (bool, error)

+ func (cmd *Command) GetIntOption(name string) (int, error)

+ func (cmd *Command) GetStringOption(name string) (string, error)

+ func (cmd *Command) GetSubcommand(arg string) (subcmd *Command)

+ func (cmd *Command) Parse(args []string) (remaining []string, err error)

+ type IntOption struct

+ Default *int

+ Description string

+ Environment string

+ Name string

+ Short string

+ func (o *IntOption) GetDescription() string

+ func (o *IntOption) GetEnvironment() string

+ func (o *IntOption) GetName() string

+ func (o *IntOption) GetShort() string

+ func (o *IntOption) HasDefault() bool

+ type Option interface

+ GetDescription func() string

+ GetEnvironment func() string

+ GetName func() string

+ GetShort func() string

+ HasDefault func() bool

+ type StringOption struct

+ Default *string

+ Description string

+ Environment string

+ Name string

+ Short string

+ func (o *StringOption) GetDescription() string

+ func (o *StringOption) GetEnvironment() string

+ func (o *StringOption) GetName() string

+ func (o *StringOption) GetShort() string

+ func (o *StringOption) HasDefault() bool