Help us shape the future of Go! Take the 2026 Go Developer Survey

clihelp

package
v1.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 26, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

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

func Configure(root *cli.Command, args []string) ([]string, bool, error)

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

func Invocation(fallback string, args []string) string

Invocation returns a copyable executable name for help examples without interpreting argv as shell syntax or displaying terminal controls.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL