XenoAtom.CommandLine Namespace

Core APIs to declare commands, options, arguments, validation, parsing, and execution for .NET command-line applications.

Classes (31)

ArgumentSourceA provider of arguments for a command.

CommandThis class represents a command that can be executed. It can contain sub-commands, options and argument sources.

CommandAppThe main entry point for a command line application.

CommandArgumentDefines a positional command argument.

CommandArgumentContextContext used when parsing a command argument.

CommandArgumentExceptionRepresents an exception that is thrown when an error occurs while parsing command arguments.

CommandConfigThe configuration for a CommandApp>.

CommandContainerA base class for a command container. Cannot be inherited directly.

CommandExceptionRepresents an exception that is thrown when an error occurs when executing a command.

CommandExtensionsExtension methods for Command and CommandContainer.

CommandGroupA group of commands that will be inlined in the parent command.

CommandNodeBase class for a command and options.

CommandOptionExceptionRepresents an exception that is thrown when an error occurs while parsing options.

CommandOutputHelperProvides helper methods for building custom ICommandOutput implementations.

CommandRunConfigConfiguration for running a command.

CommandRunContextContext used when running a command.

CommandUsageRepresents a command usage.

CompletionCommandsAdds built-in shell completion support to a CommandApp.

DefaultCommandOutputThe default plain-text output handler that reproduces the built-in help and error formatting.

HelpOptionRepresents a help option with the following default aliases: -h, -?, --help

MutuallyExclusiveConstraintDeclares that the specified options cannot be used together.

OptionDefines an option.

OptionConstraintDefines a constraint between options in a command.

OptionContextContext used when parsing an option.

OptionValueCollectionA collection of option values.

ParseResultRepresents the result of parsing command-line arguments.

RenderedInvocationRepresents a rendered invocation and token-to-text mapping.

RequiresConstraintDeclares that when the specified option is present, all required options must also be present.

ResponseFileSourceA response file source for parsing arguments from a file.

ValidateProvides built-in validators for options and arguments.

VersionOptionAn option that shows the version of the command.

Structs (5)

CommandDiagnosticProvides optional structured diagnostic context for rich error rendering.

CommandTokenSpanIdentifies a span within a token in a command line token stream.

EnumWrapper<TEnum>A wrapper around an enum that provides parsing.

UnknownTokenInfoDescribes an unknown token along with suggestions and optional diagnostics.

UnknownTokenReportRepresents an unknown-token output report with optional invocation tokens.

Interfaces (3)

ICommandNodeDescriptorProvides plain-text help description intent for a CommandNode.

ICommandOutputDefines the output handler for all user-visible output produced by the command-line parser: help text, error messages, version display, and license headers.

IHelpPreformattedContentProvides preformatted help content that should be written verbatim.

Enums (4)

CommandArgument.ValueCardinalityDefines the value cardinality for an argument.

CommandDiagnosticSourceIdentifies where a diagnostic value originated from.

OptionValueTypeSpecifies the option value type None, Optional or Required.

UnknownTokenKindIdentifies how unknown tokens should be described.

Delegates (2)

OptionValidator<T>Validates a parsed option or argument value.

ValueCompleterProvides completion candidates for a value being completed.

Remarks

This namespace contains the main object model and helpers of XenoAtom.CommandLine, including CommandApp, Command, option/argument nodes, parsing diagnostics, validation helpers, and output abstractions.