help

Documentation

Index

• type Help
  • func New(info Info, style Style) *Help
  • func (h *Help) AddCategoryDescriptions(catdescs map[string]string)
  • func (h *Help) AddCommand(category, name, description string)
  • func (h *Help) AddCommandFlags(flags []varflag.Flag)
  • func (h *Help) AddGlobalFlags(flags []varflag.Flag)
  • func (h *Help) AddSharedFlags(flags []varflag.Flag)
  • func (h *Help) Print() error
• type Info
• type Style

Types

type Help

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

func New

func New(info Info, style Style) *Help

func (*Help) AddCategoryDescriptions

func (h *Help) AddCategoryDescriptions(catdescs map[string]string)

func (*Help) AddCommand

func (h *Help) AddCommand(category, name, description string)

func (*Help) AddCommandFlags

func (h *Help) AddCommandFlags(flags []varflag.Flag)

func (*Help) AddGlobalFlags

func (h *Help) AddGlobalFlags(flags []varflag.Flag)

func (*Help) AddSharedFlags

func (h *Help) AddSharedFlags(flags []varflag.Flag)

func (*Help) Print

func (h *Help) Print() error

type Info

type Info struct {
	Name           string
	Description    string
	Version        string
	CopyrightBy    string
	CopyrightSince int
	License        string
	Address        string
	Usage          []string
	Info           []string
}

type Style

type Style struct {
	Primary     ansicolor.Style
	Info        ansicolor.Style
	Version     ansicolor.Style
	Credits     ansicolor.Style
	License     ansicolor.Style
	Description ansicolor.Style
	Category    ansicolor.Style
}