help

README

Help

This package contains all of the long-form command help templates that are displayed when a user types help <cmd>

Documentation

Index

• func FormatHelpTmpl(helpStr string) string
• func GetHelpFor(cmdName []string) string
• func HelpCmd(con *console.SliverConsoleClient) func(a *grumble.App, shell bool)

Functions

func FormatHelpTmpl

func FormatHelpTmpl(helpStr string) string

FormatHelpTmpl - Applies format template to help string

func GetHelpFor

func GetHelpFor(cmdName []string) string

GetHelpFor - Get help string for a command

func HelpCmd

func HelpCmd(con *console.SliverConsoleClient) func(a *grumble.App, shell bool)

HelpCmd - Returns an instance of the 'help' command