docs

Documentation

Index

• func ToMarkdown(app *cli.App) (string, error)
• type CliTemplate
  • func GetTemplateData(app *cli.App) *CliTemplate
• type PluginArg

Functions

func ToMarkdown

func ToMarkdown(app *cli.App) (string, error)

ToMarkdown creates a markdown string for the `*App` The function errors if either parsing or writing of the string fails.

Types

type CliTemplate

type CliTemplate struct {
	Name        string
	Version     string
	Description string
	Usage       string
	UsageText   string
	GlobalArgs  []*PluginArg
}

func GetTemplateData

func GetTemplateData(app *cli.App) *CliTemplate

type PluginArg

type PluginArg struct {
	Name        string
	EnvVars     []string
	Description string
	Default     string
	Type        string
	Required    bool
}