CommandLineHelp
ConsoleMonster.Help
Compact command-line help metadata, independent of the host's argument parser.
Inheritance
- object
- CommandLineHelp
Usage
Explore 29 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 13
- Extension method CommandLineHelp.AddCommand
- Extension method CommandLineHelp.AddCommands
- Extension method CommandLineHelp.AddValue
- Extension method CommandLineHelp.AddValues
- Extension method CommandLineHelp.WithUsage
- Extension method CommandLineHelp.WithValuesHeading
- Method CommandLineHelpFluent.AddCommand
- Method CommandLineHelpFluent.AddCommands
- Method CommandLineHelpFluent.AddValue
- Method CommandLineHelpFluent.AddValues
- Method CommandLineHelpFluent.WithUsage
- Method CommandLineHelpFluent.WithValuesHeading
- Property HelpTopic.CommandLine
Accepted by parameters 16
- Extension method CommandLineHelp.AddCommand
- Extension method CommandLineHelp.AddCommands
- Extension method CommandLineHelp.AddValue
- Extension method CommandLineHelp.AddValues
- Extension method CommandLineHelp.WithUsage
- Extension method CommandLineHelp.WithValuesHeading
- Method CommandLineHelpFluent.AddCommand
- Method CommandLineHelpFluent.AddCommands
- Method CommandLineHelpFluent.AddValue
- Method CommandLineHelpFluent.AddValues
- Method CommandLineHelpFluent.WithUsage
- Method CommandLineHelpFluent.WithValuesHeading
- Extension method HelpTopic.WithCommandLine
- Extension method HelpTopic.WithCommandLine
- Method HelpTopicFluent.WithCommandLine
- Method HelpTopicFluent.WithCommandLine
Constructors
public CommandLineHelp() #Inherited Methods
Properties
public string Usage { get; set; } #The concise usage, including the executable name and positional placeholders.
public IList<HelpCommand> Commands { get; } #Commands in display order, optionally grouped or collapsed by the host.
public string? ValuesHeading { get; set; } #Heading for a catalog of positional values, or null for the render profile's localized heading.
public IList<HelpValue> Values { get; } #Named positional values described independently of subcommands.
Extension Methods
public static CommandLineHelp AddCommand(CommandLineHelp commandLineHelp, HelpCommand item) #Adds an item to CommandLineHelp.Commands: Commands in display order, optionally grouped or collapsed by the host.
Parameters
- commandLineHelp ConsoleMonster.Help.CommandLineHelp
- The instance.
- item ConsoleMonster.Help.HelpCommand
- The item.
public static CommandLineHelp AddCommands(CommandLineHelp commandLineHelp, params HelpCommand[] items) #Adds items to CommandLineHelp.Commands: Commands in display order, optionally grouped or collapsed by the host.
Parameters
- commandLineHelp ConsoleMonster.Help.CommandLineHelp
- The instance.
- items ConsoleMonster.Help.HelpCommand[]
- The items, in order.
public static CommandLineHelp AddCommands(CommandLineHelp commandLineHelp, IEnumerable<HelpCommand> items) #Adds items to CommandLineHelp.Commands: Commands in display order, optionally grouped or collapsed by the host.
Parameters
- commandLineHelp ConsoleMonster.Help.CommandLineHelp
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpCommand>
- The items, in order.
public static CommandLineHelp AddValue(CommandLineHelp commandLineHelp, HelpValue item) #Adds an item to CommandLineHelp.Values: Named positional values described independently of subcommands.
Parameters
- commandLineHelp ConsoleMonster.Help.CommandLineHelp
- The instance.
- item ConsoleMonster.Help.HelpValue
- The item.
public static CommandLineHelp AddValues(CommandLineHelp commandLineHelp, params HelpValue[] items) #Adds items to CommandLineHelp.Values: Named positional values described independently of subcommands.
Parameters
- commandLineHelp ConsoleMonster.Help.CommandLineHelp
- The instance.
- items ConsoleMonster.Help.HelpValue[]
- The items, in order.
public static CommandLineHelp AddValues(CommandLineHelp commandLineHelp, IEnumerable<HelpValue> items) #Adds items to CommandLineHelp.Values: Named positional values described independently of subcommands.
Parameters
- commandLineHelp ConsoleMonster.Help.CommandLineHelp
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpValue>
- The items, in order.
public static CommandLineHelp WithUsage(CommandLineHelp commandLineHelp, string value) #Sets CommandLineHelp.Usage: The concise usage, including the executable name and positional placeholders.
Parameters
- commandLineHelp ConsoleMonster.Help.CommandLineHelp
- The instance.
- value string
- The value.
public static CommandLineHelp WithValuesHeading(CommandLineHelp commandLineHelp, string? value) #Sets CommandLineHelp.ValuesHeading: Heading for a catalog of positional values, or null for the render profile's localized heading.
Parameters
- commandLineHelp ConsoleMonster.Help.CommandLineHelp
- The instance.
- value string?
- The value.