help

Documentation

Index

• type Help
  • func NewHelp(description, example, notes, usage string) Help
  • func (h *Help) Description() string
  • func (h *Help) Example() string
  • func (h *Help) Notes() string
  • func (h *Help) String() string
  • func (h *Help) Usage() string

Types

type Help

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

Help captures the pertitenent pieces of information for a CLI command

func NewHelp

func NewHelp(description, example, notes, usage string) Help

NewHelp is a factory to build and return a Help structure

func (*Help) Description

func (h *Help) Description() string

Description returns a single sentence description of the command

func (*Help) Example

func (h *Help) Example() string

Example returns an example of running the command

func (*Help) Notes

func (h *Help) Notes() string

Notes returns any additional information that is relevant to understanding the command

func (*Help) String

func (h *Help) String() string

String returns the command's usage as the required and optional arguments along with exclusive groupings

func (*Help) Usage

func (h *Help) Usage() string

Usage returns the command's required and optional arguments along with exclusive groupings