clihelp

package

v1.21.83 Latest Latest Go to latest Published: Oct 25, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Package clihelp holds the long-form help content of the clicky CLI: the pretty-printing API guide and the schema documentation/example.

This section is empty.

View Source

var ExampleSchema string

View Source

var SchemaDocumentation string

func RenderPrettyGuide(w io.Writer, root *cobra.Command) error

RenderPrettyGuide writes the guide for root's `pretty` subcommand to w.

type PrettyGuide struct {
	Command *cobra.Command
}

PrettyGuide renders the pretty-printing API guide; Command supplies the live usage line and flags of the `pretty` command when it is present.

func (g PrettyGuide) Pretty() api.Text