help

Documentation

Index

• func ShowCommandHelp(help CommandHelp)
• func ShowMainUsage()
• func ShowVersion(version, commit, date string)
• type CommandHelp
  • func GetCommandHelp(commandName string) *CommandHelp
• type FlagHelp

Functions

func ShowCommandHelp

func ShowCommandHelp(help CommandHelp)

ShowCommandHelp displays help for a specific command

func ShowMainUsage

func ShowMainUsage()

ShowMainUsage displays the main help screen with colored output

func ShowVersion

func ShowVersion(version, commit, date string)

ShowVersion displays version information with colors

Types

type CommandHelp

type CommandHelp struct {
	Name        string
	Description string
	Usage       string
	Examples    []string
	Flags       []FlagHelp
}

CommandHelp represents help information for a command

func GetCommandHelp

func GetCommandHelp(commandName string) *CommandHelp

GetCommandHelp returns help information for built-in commands

type FlagHelp

type FlagHelp struct {
	Name        string
	Type        string
	Default     string
	Description string
}

FlagHelp represents help information for a flag