help

Documentation

Index

• Variables
• type Command
  • func (c Command) Alias() string
  • func (h Command) HelpText() string
  • func (h Command) Name() string
  • func (h Command) ParentName() string
  • func (h *Command) Receive(pl []core.Plugin)
  • func (h *Command) Run(ctx context.Context, root string, args []string) error

Variables

var (
	ErrSubCommandNotFound = errors.New("subcommand not found")
)

Types

type Command

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

Help command that prints

func (Command) Alias

func (c Command) Alias() string

func (Command) HelpText

func (h Command) HelpText() string

HelpText for the Help command

func (Command) Name

func (h Command) Name() string

func (Command) ParentName

func (h Command) ParentName() string

func (*Command) Receive

func (h *Command) Receive(pl []core.Plugin)

Receive the plugins and stores the Commands for later usage on the help text.

func (*Command) Run

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

Run the help command