clihelp

package
v1.21.97 Latest Latest
Warning

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

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

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

View Source
var ExampleSchema string
View Source
var SchemaDocumentation string

Functions

func RenderPrettyGuide

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

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

Types

type PrettyGuide

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 (PrettyGuide) Pretty

func (g PrettyGuide) Pretty() api.Text

Jump to

Keyboard shortcuts

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