help

package

v0.0.2 Latest Latest Go to latest Published: Feb 28, 2024 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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