Categorygithub.com/spoke-d/cluihelp
package
0.0.0-20210429125405-5d27ecb8db26
Repository: https://github.com/spoke-d/clui.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
7
Dependents
1
Files
279 SLOC

# Functions

BasicFunc generates some bashic help output that is usually good enough for most CLI applications.
OptionColor allows the setting a color option to configure the group.
OptionCommands allows the setting a commands option to configure the group.
OptionErr allows the setting a hint option to configure the group.
OptionFlags allows the setting a commands option to configure the group.
OptionFormat allows the setting a format option to configure the group.
OptionHeader allows the setting a header option to configure the group.
OptionHelp allows the setting a hint option to configure the group.
OptionHint allows the setting a hint option to configure the group.
OptionShowHelp allows the setting a color option to configure the group.
OptionTemplate allows the setting a template option to configure the group.
OptionUsages allows the setting a commands option to configure the group.

# Constants

BasicHelpTemplate is the current view template of the help output.
CommandHelpTemplate represents a template for rendering the help for commands and subcommands.
HelpTemplateFormat defines a basic format for templating a help template.

# Interfaces

Command represents an abstraction of command.
HelpOptions represents a way to set optional values to a autocomplete option.

# Type aliases

Func is the type of the function that is responsible for generating the help output when the CLI must show the general help text.
HelpOption captures a tweak that can be applied to the Help.