cli

Jan 4, 2025

Changes in this version

type Option

+ func NoColour(noColour bool) Option

+ func OptionalArg(name, description, value string) Option

+ func RequiredArg(name, description string) Option

Sep 27, 2024

Changes in this version

type Command

+ func (c *Command) Arg(name string) string

type Option

+ func Arg(name, description, value string) Option

+ func OverrideArgs(args []string) Option

Aug 23, 2024

Changes in this version

+ type Builder func() (*Command, error)

Aug 20, 2024

Changes in this version

type Option

+ func BuildDate(date string) Option

+ func Commit(commit string) Option

Aug 11, 2024

Changes in this version

+ const NoShortHand

+ type ArgValidator func(cmd *Command, args []string) error

+ func AnyArgs() ArgValidator

+ func BetweenArgs(min, max int) ArgValidator

+ func Combine(validators ...ArgValidator) ArgValidator

+ func ExactArgs(n int) ArgValidator

+ func MaxArgs(n int) ArgValidator

+ func MinArgs(n int) ArgValidator

+ func NoArgs() ArgValidator

+ func ValidArgs(valid []string) ArgValidator

+ type Command struct

+ func New(name string, options ...Option) (*Command, error)

+ func (c *Command) Execute() error

+ func (c *Command) ExtraArgs() (args []string, ok bool)

+ func (c *Command) Stderr() io.Writer

+ func (c *Command) Stdin() io.Reader

+ func (c *Command) Stdout() io.Writer

+ type FlagCount = flag.Count

+ type Flaggable = flag.Flaggable

+ type Option interface

+ func Allow(validator ArgValidator) Option

+ func Args(args []string) Option

+ func Example(comment, command string) Option

+ func Flag[T Flaggable](p *T, name string, short rune, value T, usage string) Option

+ func Long(long string) Option

+ func Run(run func(cmd *Command, args []string) error) Option

+ func Short(short string) Option

+ func Stderr(stderr io.Writer) Option

+ func Stdin(stdin io.Reader) Option

+ func Stdout(stdout io.Writer) Option

+ func SubCommands(subcommands ...*Command) Option

+ func Version(version string) Option

+ func VersionFunc(fn func(cmd *Command) error) Option