format

Documentation

Index

• Constants
• func EnhanceHelper(command *cobra.Command)
• func RegisterTemplateFuncs()

Constants

const (
	OnlyUsageString = "{{if or .Runnable .HasSubCommands}}{{.UsageString}}{{end}}"
	ADocHelpTable   = `{{if .HasAvailableLocalFlags}}{{ $tick := "` + "`" + `" }}
[cols="2,4,2,1"]
|===
|Option|Purpose|Format|Default
{{range localFlagsSlice .LocalFlags}}{{ if not .Hidden }}
|{{$tick}}--{{.Name}}{{$tick}} {{if .Shorthand}}({{$tick}}-{{.Shorthand}}{{$tick}}){{end}}
|{{.Usage}}
|{{type .}}
|{{if .DefValue}}{{$tick}}{{.DefValue | trimTrailingWhitespaces}}{{$tick}}{{end}}{{end}}
{{end}}
|===
{{end}}`
)

Functions

func EnhanceHelper

func EnhanceHelper(command *cobra.Command)

EnhanceHelper wraps helper function with alternative formatting and templates (e.g. asciidoc) based on --helper-format flag Applies to all subcommands. This can be useful when automatically generating documentation for CLI.

func RegisterTemplateFuncs

func RegisterTemplateFuncs()