explain

Documentation

Index

• Variables
• type ExplainCommand
  • func (e *ExplainCommand) CreateCommand() *cobra.Command

Variables

var Long = heredoc.Doc(`
	Present documentation about various topics. You can list available topics,
	filter the list of available topics, render a single topic to the terminal,
	and automatically navigate to the webpage for a document. By default, it
	lists all available topics in a table with their topic, description category,
	and tags.
`)

this string is shown in the help output of this command.

var Short = "Present documentation about topics"

This string is shown in the help output of the root command.

var Use = "explain [topic] [--list]"

Cobra expects a string that explains the usage of a command and recommends the following syntax:

[ ] identifies an optional argument. Arguments that are not enclosed in brackets are required.
... indicates that you can specify multiple values for the previous argument.
|   indicates mutually exclusive information. You can use the argument to the left of the separator or the
    argument to the right of the separator. You cannot use both arguments in a single use of the command.
{ } delimits a set of mutually exclusive arguments when one of the arguments is required. If the arguments are
    optional, they are enclosed in brackets ([ ]).

Types

type ExplainCommand

type ExplainCommand struct {
	Dossier    *dossier.Dossier
	DocsUri    string
	Online     bool
	ListTopics bool
	Tag        string
	Category   string
	Topic      string
}

ExplainCommand contains all the necessary information to display non-reference documentation at the terminal

func (*ExplainCommand) CreateCommand

func (e *ExplainCommand) CreateCommand() *cobra.Command

Create command instantiates a cobra command that can be added to an application to render non-reference documentation at the terminal or send the user to the appropriate web page.