help

Documentation

Index

• type CmdHelp
  • func (h *CmdHelp) ParseAndRun(args []string) ([]string, error)
  • func (h *CmdHelp) PrintHelpAndExit(cmd string, exitCode int)
• type HelpArgs
• type HelpDict
  • func (h HelpDict) PrintHelpAndExit(main CmdHelp, args []string, exitCode int)

Types

type CmdHelp

type CmdHelp struct {
	HelpTxt string
	HelpCtx func(cmd string) any
}

func (*CmdHelp) ParseAndRun

func (h *CmdHelp) ParseAndRun(args []string) ([]string, error)

func (*CmdHelp) PrintHelpAndExit

func (h *CmdHelp) PrintHelpAndExit(cmd string, exitCode int)

type HelpArgs

type HelpArgs struct {
	OnHelp func() `long:"help" short:"h"`
}

type HelpDict

type HelpDict map[string]CmdHelp

func (HelpDict) PrintHelpAndExit

func (h HelpDict) PrintHelpAndExit(main CmdHelp, args []string, exitCode int)