1. Home
  2. API
  3. XenoAtom.CommandLine.Terminal
  4. CommandTerminalExtensions
  5. Methods
  6. ToHelpVisual(Command, TerminalVisualOutputOptions?)

ToHelpVisual(Command, TerminalVisualOutputOptions?) Method

Definition

Assembly XenoAtom.CommandLine.Terminal.dll
View source

Builds a help visual for the specified command.

public static Visual ToHelpVisual(this Command command, TerminalVisualOutputOptions? options = null)

Parameters

command
Command

The command to visualize.

options
TerminalVisualOutputOptions

Optional visual generation options.

Returns

XenoAtom.Terminal.UI.Visual
A visual that can be rendered with Terminal.Write(visual) or embedded in another UI tree.