Documentation
¶
Overview ¶
Package clihelp owns local onboarding and help-topic routing. Feature commands supply their own brief and full templates through command metadata.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Configure ¶
Configure keeps onboarding in CLI help, never in a shell startup file or an API command's output. Normalize help before Run so the framework still owns parsing, parent links and rendering, while help skips request setup. Commands marked "local-help" only display guidance; "local-help-full" supplies an optional full reference template used by help --all.
func Invocation ¶
Invocation returns a copyable executable name for help examples without interpreting argv as shell syntax or displaying terminal controls.
func VisibleCommands ¶ added in v1.38.0
VisibleCommands gives help and completion the same order without changing parser definitions. Actions precede groups; equal ranks retain source order. Curated commands can preserve their complete declaration order through metadata.
Types ¶
type FlagGroup ¶ added in v1.29.0
type FlagGroup struct {
Title string
Names []string
// Owner restricts a group to flags declared by this command. Nil matches by name.
Owner *cli.Command
}
FlagGroup is presentation metadata supplied by handwritten features. It never changes parser order, categories, flag aliases or request defaults.
type UnknownTopicError ¶ added in v1.38.0
UnknownTopicError retains the last valid group for safe local recovery guidance. Presenters can suggest declared commands without echoing an untrusted topic.
func (*UnknownTopicError) Error ¶ added in v1.38.0
func (e *UnknownTopicError) Error() string
func (*UnknownTopicError) ExitCode ¶ added in v1.38.0
func (*UnknownTopicError) ExitCode() int
Source Files