Documentation
¶
Index ¶
- Constants
- func Examples(s string) string
- func LongDesc(s string) string
- func MainHelpTemplate() string
- func MainUsageTemplate() string
- func Normalize(cmd *cobra.Command) *cobra.Command
- func NormalizeAll(cmd *cobra.Command) *cobra.Command
- func OptionsHelpTemplate() string
- func OptionsUsageTemplate() string
- func UseOptionsTemplates(cmd *cobra.Command)
- type ASCIIRenderer
- type CommandGroup
- type CommandGroups
- type FlagExposer
- type HelpFlagPrinter
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}}`
)
const Indentation = ` `
Variables ¶
This section is empty.
Functions ¶
func Examples ¶
func Examples(s string) string
Examples normalizes a command's examples to follow the conventions.
func LongDesc ¶
func LongDesc(s string) string
LongDesc normalizes a command's long description to follow the conventions.
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 Normalize ¶
func Normalize(cmd *cobra.Command) *cobra.Command
Normalize perform all required normalizations on a given command.
func NormalizeAll ¶
func NormalizeAll(cmd *cobra.Command) *cobra.Command
NormalizeAll perform all required normalizations in the entire command tree.
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 ¶
func UseOptionsTemplates(cmd *cobra.Command)
Types ¶
type ASCIIRenderer ¶
type ASCIIRenderer struct {
Indentation string
// contains filtered or unexported fields
}
ASCIIRenderer is a blackfriday.Renderer intended for rendering markdown documents as plain text, well suited for human reading on terminals.
func (*ASCIIRenderer) RenderFooter ¶ added in v0.26.0
func (r *ASCIIRenderer) RenderFooter(w io.Writer, ast *blackfriday.Node)
RenderFooter writes document footer.
func (*ASCIIRenderer) RenderHeader ¶ added in v0.26.0
func (r *ASCIIRenderer) RenderHeader(w io.Writer, ast *blackfriday.Node)
RenderHeader writes document preamble and TOC if requested.
func (*ASCIIRenderer) RenderNode ¶ added in v0.26.0
func (r *ASCIIRenderer) RenderNode(w io.Writer, node *blackfriday.Node, entering bool) blackfriday.WalkStatus
render markdown to text
type CommandGroup ¶
type CommandGroup struct {
Message string
Commands []*cobra.Command
}
type CommandGroups ¶
type CommandGroups []CommandGroup
func AddAdditionalCommands ¶
func AddAdditionalCommands(g CommandGroups, message string, cmds []*cobra.Command) CommandGroups
type FlagExposer ¶
type FlagExposer interface {
ExposeFlags(cmd *cobra.Command, flags ...string) FlagExposer
}
func ActsAsRootCommand ¶
func ActsAsRootCommand(cmd *cobra.Command, filters []string, groups ...CommandGroup) FlagExposer
type HelpFlagPrinter ¶ added in v0.24.0
type HelpFlagPrinter struct {
// contains filtered or unexported fields
}
HelpFlagPrinter is a printer that processes the help flag and print it to i/o writer
func NewHelpFlagPrinter ¶ added in v0.24.0
func NewHelpFlagPrinter(out io.Writer, wrapLimit uint) *HelpFlagPrinter
NewHelpFlagPrinter will initialize a HelpFlagPrinter given the i/o writer
func (*HelpFlagPrinter) PrintHelpFlag ¶ added in v0.24.0
func (p *HelpFlagPrinter) PrintHelpFlag(flag *flag.Flag)
PrintHelpFlag will beautify the help flags and print it out to p.out