CommandOutputHelper Class

Definition

Assembly XenoAtom.CommandLine.dll

Inherits Object

Show inherited members (7)

Provides helper methods for building custom ICommandOutput implementations.

public static class CommandOutputHelper

Tip: use kind:method, kind:property, kind:ctor. Press Esc to clear.

GetDefaultUsageSyntax(Command)Gets the default usage syntax string for a command.

GetDescriptionText(String?)Gets only the description text from a descriptor description, stripping placeholder metadata.

GetFullCommandPath(Command)Gets the full command path for a command.

GetHelpHint(Command)Gets the default usage hint text for a command.

GetOptionValueName(Option, Int32)Gets the display name for an option value placeholder from its description.

GetVisibleArguments(Command)Gets the active, visible positional arguments for a command.

GetVisibleOptions(Command)Gets the active, visible options for a command (deduplicated across aliases).

GetVisibleSubCommands(Command)Gets the active, visible sub-commands for a command.

RenderInvocation(Command, IReadOnlyList<String>)Renders an invocation line by combining the command path and provided tokens.