commander

package

v0.1.5 Latest Latest Go to latest Published: Jun 4, 2022 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/livebud/bud

Links

Open Source Insights

Documentation ¶

Index ¶

func Usage() error
type Arg
- func (a *Arg) Custom(fn func(string) error) *Custom
- func (a *Arg) Int(target *int) *Int
- func (a *Arg) String(target *string) *String
- func (a *Arg) StringMap(target *map[string]string) *StringMap
type Args
- func (a *Args) Strings(target *[]string) *Strings
type Bool
- func (v *Bool) Default(value bool)
- func (v *Bool) Optional()
type CLI
- func New(name string) *CLI
- func (c *CLI) Arg(name string) *Arg
- func (c *CLI) Args(name string) *Args
- func (c *CLI) Command(name, usage string) *Command
- func (c *CLI) Flag(name, usage string) *Flag
- func (c *CLI) Parse(ctx context.Context, args []string) error
- func (c *CLI) Run(runner func(ctx context.Context) error)
- func (c *CLI) Template(template *template.Template)
- func (c *CLI) Trap(signals ...os.Signal)
- func (c *CLI) Version(version string) *CLI
- func (c *CLI) Writer(writer io.Writer) *CLI
type Command
- func (c *Command) Arg(name string) *Arg
- func (c *Command) Args(name string) *Args
- func (c *Command) Command(name, usage string) *Command
- func (c *Command) Flag(name, usage string) *Flag
- func (c *Command) Run(runner func(ctx context.Context) error)
type Custom
- func (v *Custom) Default(value string)
- func (v *Custom) Optional()
type Flag
- func (f *Flag) Bool(target *bool) *Bool
- func (f *Flag) Custom(fn func(string) error) *Custom
- func (f *Flag) Int(target *int) *Int
- func (f *Flag) Short(short byte) *Flag
- func (f *Flag) String(target *string) *String
- func (f *Flag) StringMap(target *map[string]string) *StringMap
- func (f *Flag) Strings(target *[]string) *Strings
type Int
- func (v *Int) Default(value int)
- func (v *Int) Optional()
type String
- func (v *String) Default(value string)
- func (v *String) Optional()
type StringMap
- func (v *StringMap) Default(value map[string]string)
- func (v *StringMap) Optional()
type Strings
- func (v *Strings) Default(values ...string)
- func (v *Strings) Optional()

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Usage ¶

func Usage() error

Types ¶

type Arg ¶

type Arg struct {
	Name string
	// contains filtered or unexported fields
}

func (*Arg) Custom ¶ added in v0.1.5

func (a *Arg) Custom(fn func(string) error) *Custom

Custom allows you to define a custom parsing function

func (*Arg) Int ¶

func (a *Arg) Int(target *int) *Int

func (*Arg) String ¶

func (a *Arg) String(target *string) *String

func (*Arg) StringMap ¶

func (a *Arg) StringMap(target *map[string]string) *StringMap

type Args ¶

type Args struct {
	Name string
	// contains filtered or unexported fields
}

func (*Args) Strings ¶

func (a *Args) Strings(target *[]string) *Strings

type Bool ¶

type Bool struct {
	// contains filtered or unexported fields
}

func (*Bool) Default ¶

func (v *Bool) Default(value bool)

func (*Bool) Optional ¶

func (v *Bool) Optional()

type CLI ¶

type CLI struct {
	// contains filtered or unexported fields
}

func New ¶

func New(name string) *CLI

func (*CLI) Arg ¶

func (c *CLI) Arg(name string) *Arg

func (*CLI) Args ¶

func (c *CLI) Args(name string) *Args

func (*CLI) Command ¶

func (c *CLI) Command(name, usage string) *Command

func (*CLI) Flag ¶

func (c *CLI) Flag(name, usage string) *Flag

func (*CLI) Parse ¶

func (c *CLI) Parse(ctx context.Context, args []string) error

func (*CLI) Run ¶

func (c *CLI) Run(runner func(ctx context.Context) error)

func (*CLI) Template ¶

func (c *CLI) Template(template *template.Template)

func (*CLI) Trap ¶

func (c *CLI) Trap(signals ...os.Signal)

func (*CLI) Version ¶

func (c *CLI) Version(version string) *CLI

func (*CLI) Writer ¶

func (c *CLI) Writer(writer io.Writer) *CLI

type Command ¶

type Command struct {
	// contains filtered or unexported fields
}

func (*Command) Arg ¶

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

func (*Command) Args ¶

func (c *Command) Args(name string) *Args

func (*Command) Command ¶

func (c *Command) Command(name, usage string) *Command

func (*Command) Flag ¶

func (c *Command) Flag(name, usage string) *Flag

func (*Command) Run ¶

func (c *Command) Run(runner func(ctx context.Context) error)

type Custom ¶ added in v0.1.5

type Custom struct {
	// contains filtered or unexported fields
}

func (*Custom) Default ¶ added in v0.1.5

func (v *Custom) Default(value string)

func (*Custom) Optional ¶ added in v0.1.5

func (v *Custom) Optional()

type Flag ¶

type Flag struct {
	// contains filtered or unexported fields
}

func (*Flag) Bool ¶

func (f *Flag) Bool(target *bool) *Bool

func (*Flag) Custom ¶ added in v0.1.5

func (f *Flag) Custom(fn func(string) error) *Custom

Custom allows you to define a custom parsing function

func (*Flag) Int ¶

func (f *Flag) Int(target *int) *Int

func (*Flag) Short ¶

func (f *Flag) Short(short byte) *Flag

func (*Flag) String ¶

func (f *Flag) String(target *string) *String

func (*Flag) StringMap ¶

func (f *Flag) StringMap(target *map[string]string) *StringMap

func (*Flag) Strings ¶

func (f *Flag) Strings(target *[]string) *Strings

type Int ¶

type Int struct {
	// contains filtered or unexported fields
}

func (*Int) Default ¶

func (v *Int) Default(value int)

func (*Int) Optional ¶

func (v *Int) Optional()

type String ¶

type String struct {
	// contains filtered or unexported fields
}

func (*String) Default ¶

func (v *String) Default(value string)

func (*String) Optional ¶

func (v *String) Optional()

type StringMap ¶

type StringMap struct {
	// contains filtered or unexported fields
}

func (*StringMap) Default ¶

func (v *StringMap) Default(value map[string]string)

func (*StringMap) Optional ¶

func (v *StringMap) Optional()

type Strings ¶

type Strings struct {
	// contains filtered or unexported fields
}

func (*Strings) Default ¶

func (v *Strings) Default(values ...string)

func (*Strings) Optional ¶

func (v *Strings) Optional()

Source Files ¶

View all Source files

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