Documentation ¶
Index ¶
Constants ¶
const ( // SectionVars is the help template section that declares variables to be used in the template. SectionVars = `{{$isRootCmd := isRootCmd .}}` + `{{$rootCmd := rootCmd .}}` + `{{$visibleFlags := visibleFlags (flagsNotIntersected .LocalFlags .PersistentFlags)}}` + `{{$explicitlyExposedFlags := exposed .}}` + `{{$optionsCmdFor := optionsCmdFor .}}` + `{{$usageLine := usageLine .}}` // SectionAliases is the help template section that displays command aliases. SectionAliases = `{{if gt .Aliases 0}}Aliases: {{.NameAndAliases}} {{end}}` // SectionExamples is the help template section that displays command examples. SectionExamples = `{{if .HasExample}}Examples: {{trimRight .Example}} {{end}}` // SectionSubcommands is the help template section that displays the command's subcommands. SectionSubcommands = `{{if .HasAvailableSubCommands}}{{cmdGroupsString .}} {{end}}` // SectionFlags is the help template section that displays the command's flags. SectionFlags = `` /* 298-byte string literal not displayed */ // SectionUsage is the help template section that displays the command's usage. SectionUsage = `{{if and .Runnable (ne .UseLine "") (ne .UseLine $rootCmd)}}Usage: {{$usageLine}} {{end}}` // SectionTipsHelp is the help template section that displays the '--help' hint. SectionTipsHelp = `{{if .HasSubCommands}}Use "{{$rootCmd}} <command> --help" for more information about a given command. {{end}}` // SectionTipsGlobalOptions is the help template section that displays the 'options' hint for displaying global flags. SectionTipsGlobalOptions = `{{if $optionsCmdFor}}Use "{{$optionsCmdFor}}" for a list of global command-line options (applies to all commands). {{end}}` )
Variables ¶
This section is empty.
Functions ¶
func MainHelpTemplate ¶
func MainHelpTemplate() string
MainHelpTemplate if the template for 'help' used by most commands.
func MainUsageTemplate ¶
func MainUsageTemplate() string
MainUsageTemplate if the template for 'usage' used by most commands.
func OptionsHelpTemplate ¶
func OptionsHelpTemplate() string
OptionsHelpTemplate if the template for 'help' used by the 'options' command.
func OptionsUsageTemplate ¶
func OptionsUsageTemplate() string
OptionsUsageTemplate if the template for 'usage' used by the 'options' command.
func UseOptionsTemplates ¶
UseOptionsTemplates docs to be written TODO: write UseOptionsTemplates docs
Types ¶
type CommandGroup ¶
CommandGroup represents the commands that are grouped together within the help output
type CommandGroups ¶
type CommandGroups []CommandGroup
CommandGroups is just a slice of type CommandGroup
func AddAdditionalCommands ¶
func AddAdditionalCommands(g CommandGroups, message string, cmds []*cobra.Command) CommandGroups
AddAdditionalCommands creates a new CommandGroup and returns the CommandGroups slice
func (CommandGroups) Add ¶
func (g CommandGroups) Add(c *cobra.Command)
Add adds a cobra command all groups within the CommandGroups
type FlagExposer ¶
type FlagExposer interface {
ExposeFlags(cmd *cobra.Command, flags ...string) FlagExposer
}
FlagExposer exposes flags! Fancy that
func ActsAsRootCommand ¶
func ActsAsRootCommand(cmd *cobra.Command, filters []string, groups ...CommandGroup) FlagExposer
ActsAsRootCommand defines which command is the "root" command for groups