module

Shell::AutoComplete::Help

Constants

DEFAULT_SECTION_ORDER = [:description, :options, :subcommands, :positionals]

Class methods

render(command_name : String, description : String, flags : Array(FlagRow), subcommands : Array(SubcommandRow) = [] of SubcommandRow, positionals : Array(PositionalRow) = [] of PositionalRow, header : String | Nil = nil, footer : String | Nil = nil, usage : String | Nil = nil, qualified_name : String | Nil = nil, section_order : Array(Symbol) | Nil = nil) : String

Renders a command's help text. The header and Usage: line always lead and the footer always trails; section_order controls the middle sections (any subset/ordering of :description, :options, :subcommands, :positionals). Flags with a group: render under their own heading after the ungrouped options, in first-appearance order.

Source

Nested types