clihelp

Aug 31, 2026

Changes in this version

+ func ColorizeExampleLineWithApp(app *App, cmd *Command, line string, th Theme) string

type App

+ func (a *App) CollectOptions(path []string, cmd *Command) []Option

Aug 31, 2026

Changes in this version

+ func ColorizeExampleLine(line string, th Theme) string

+ func CompletionPath(app *App, shell string) (string, error)

+ func IsCompletionInstalled(app *App, shell string) bool

+ func SplitExampleCommandLine(line string) ([]string, error)

+ func ValidateExample(app *App, ex Example, cmd *Command) error

type App

+ AutoInstallCompletion bool

+ Examples []Example

+ OmitGlobalFlagsInCommands bool

+ func (a *App) CheckExample(ex Example, cmd *Command) error

+ func (a *App) RenderFlags(o Options)

+ func (a *App) RenderGlobalFlags(o Options)

+ func (a *App) RenderHelpTopics(o Options)

+ func (a *App) RenderMan(o Options)

+ func (a *App) ValidateAllExamples() error

+ func (a *App) ValidateExamples() []error

type AuditOptions

+ SkipExampleValidation bool

type Option

+ Group string

+ func Group(group string, opt Option) Option

type Theme

+ ExampleArg *color.Color

+ ExampleCmd *color.Color

+ ExampleComment *color.Color

+ ExampleDesc *color.Color

+ ExampleFlag *color.Color

Aug 29, 2026

Changes in this version

+ var SupportedShells = []string

+ func GenFishCompletion(app *App, w io.Writer) error

+ func InstallCompletion(app *App, shell string) (string, error)

type Command

+ func CompletionCommand() Command

Aug 29, 2026

Changes in this version

+ func Audit(app *App) error

+ func AuditWithOptions(app *App, opts AuditOptions) error

type App

+ InteractiveFallback bool

+ Stdin io.Reader

+ type AuditOptions struct

+ AllowPathPermutations [][]string

type Command

+ OptionsValidator OptionsValidator

type Option

+ Required bool

+ func Required(opt Option) Option

+ type OptionsValidator func(fs *pflag.FlagSet) error

+ func MutuallyExclusive(flags ...string) OptionsValidator

+ func RequiredIf(flag string, condition string) OptionsValidator

+ func RequiredTogether(flags ...string) OptionsValidator

+ func RequiredWith(target string, required ...string) OptionsValidator

+ func ValidateOptions(validators ...OptionsValidator) OptionsValidator

+ type TestResult struct

+ Error error

+ Stderr string

+ Stdout string

+ func TestExecute(app *App, args []string) *TestResult

+ func TestExecuteWithStdin(app *App, args []string, stdin io.Reader) *TestResult

+ func (tr *TestResult) AssertErrorContains(t *testing.T, substring string)

+ func (tr *TestResult) AssertNoError(t *testing.T)

+ func (tr *TestResult) AssertStderrContains(t *testing.T, substring string)

+ func (tr *TestResult) AssertStdoutContains(t *testing.T, substring string)

type Theme

+ Flag *color.Color

Aug 26, 2026

Changes in this version

+ const DefaultMaxColIndent

+ func DisplayName(c Command) string

+ func DisplayNameWithArgs(c Command) string

+ func FirstSentence(s string) string

+ func GenBashCompletion(app *App, w io.Writer) error

+ func GenZshCompletion(app *App, w io.Writer) error

+ func Inline(s string) string

+ func NoArgs(args []string) error

+ func RenderMarkdown(a *App, o MarkdownOptions) (changed bool, err error)

+ type App struct

+ AbbrevCommands bool

+ AfterRun func(ctx *Context) error

+ BeforeRun func(ctx *Context) error

+ Commands []Command

+ ConfigPath string

+ Description string

+ GlobalFlags []Option

+ GlobalNote string

+ Name string

+ Pager bool

+ PersistentOptions []Option

+ Run func(ctx *Context) error

+ Shortcuts []Command

+ Stderr io.Writer

+ Stdout io.Writer

+ Theme *Theme

+ UsageLine string

+ Version string

+ func (a *App) Execute(args []string) error

+ func (a *App) ExecuteContext(ctx context.Context, args []string) error

+ func (a *App) LookupCommand(path ...string) *Command

+ func (a *App) PrintError(err error)

+ func (a *App) Render(o Options, path ...string) bool

+ func (a *App) RenderCommand(o Options, path ...string) bool

+ func (a *App) RenderGlobal(o Options)

+ func (a *App) RenderTree(o Options)

+ type ArgsValidator func(args []string) error

+ func ExactArgs(n int) ArgsValidator

+ func MaximumNArgs(n int) ArgsValidator

+ func MinimumNArgs(n int) ArgsValidator

+ func RangeArgs(min, max int) ArgsValidator

+ type Command struct

+ Aliases []string

+ Args ArgsValidator

+ Description string

+ Examples []Example

+ Group string

+ Hidden bool

+ Name string

+ Notes []Note

+ Options []Option

+ Parameters []Param

+ PersistentOptions []Option

+ PostRun func(ctx *Context) error

+ PreRun func(ctx *Context) error

+ Run func(ctx *Context) error

+ SubcommandEntries []Param

+ Subcommands []Command

+ Title string

+ UsageLine string

+ type Context struct

+ App *App

+ Args []string

+ Command *Command

+ Context context.Context

+ RawArgs []string

+ Stderr io.Writer

+ Stdout io.Writer

+ type Example struct

+ Description string

+ Line string

+ type MarkdownOptions struct

+ Dir string

+ type Note struct

+ Heading string

+ Text string

+ type Option struct

+ Binder func(fs *pflag.FlagSet) error

+ Complete func(toComplete string) []string

+ DefaultText string

+ Deprecated string

+ Description string

+ Flags string

+ Hidden bool

+ func Bool(target *bool, flags string, defaultVal bool, usage string) Option

+ func BoolToggle(target *bool, flags string, defaultVal bool, usage string) Option

+ func Duration(target *time.Duration, flags string, defaultVal time.Duration, usage string) Option

+ func Enum(target *string, flags string, allowed []string, defaultVal string, ...) Option

+ func Int(target *int, flags string, defaultVal int, usage string) Option

+ func String(target *string, flags string, defaultVal string, usage string) Option

+ func StringSlice(target *[]string, flags string, defaultVal []string, usage string) Option

+ func Var(target pflag.Value, flags string, usage string) Option

+ type Options struct

+ MaxContentWidth int

+ Pager bool

+ Theme *Theme

+ Width int

+ Writer io.Writer

+ type Param struct

+ Description string

+ Name string

+ type Theme struct

+ Accent *color.Color

+ Body *color.Color

+ Hdr *color.Color

+ Separator bool

+ Subcommand *color.Color

+ TitlePrefix string