help

package

v0.0.3 Latest Latest Go to latest Published: May 30, 2024 License: MIT Imports: 7 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type CommandDescriptor interface {
	ShortDescription() string
}

type Help interface {
	Write(w io.Writer) error

	AppendFlags(...params.Flag)
}

func New(
	fullname string, shortDescription string,
	options ...Option,
) Help

type Option func(*help) *help

func WitArgs(arg []params.Arg) Option

func WithDescription(tpl *template.Template) Option

func WithFlags(flg []params.Flag) Option

func WithSubcommands(cmds map[string]CommandDescriptor) Option