help

Documentation

Index

• func OutlineCommandHelp(cur *command.Command, helpInfo common.HelpInfo) command.Action
• func OutlineSectionHelp(_ *section.SectionT, hi common.HelpInfo) command.Action
• type CommandHelp
• type HelpFlagMapping
  • func BuiltinHelpFlagMappings() []HelpFlagMapping
• type SectionHelp

Functions

func OutlineCommandHelp

func OutlineCommandHelp(cur *command.Command, helpInfo common.HelpInfo) command.Action

func OutlineSectionHelp

func OutlineSectionHelp(_ *section.SectionT, hi common.HelpInfo) command.Action

Types

type CommandHelp

type CommandHelp func(cur *command.Command, helpInfo common.HelpInfo) command.Action

type HelpFlagMapping

type HelpFlagMapping struct {
	Name        string
	CommandHelp CommandHelp
	SectionHelp SectionHelp
}

HelpFlagMapping adds a new option to your --help flag

func BuiltinHelpFlagMappings

func BuiltinHelpFlagMappings() []HelpFlagMapping

BuiltinHelpFlagMappings is a convenience method that contains help flag mappings built into warg. Feel free to use it as a base to custimize help functions for your users

type SectionHelp

type SectionHelp func(cur *section.SectionT, helpInfo common.HelpInfo) command.Action