Show / Hide Table of Contents

    Namespace McMaster.Extensions.CommandLineUtils

    Classes

    ArgumentAttribute

    Represents one or many positional command line arguments. Arguments are parsed based the Order given. Compare to OptionAttribute.

    ArgumentEscaper

    A utility for escaping arguments for new processes.

    CommandArgument

    Represents one or many positional command line arguments. Arguments are parsed in the order in which Arguments lists them. Compare to CommandOption.

    CommandAttribute

    Represents a command line application using attributes to define options and arguments.

    CommandLineApplication

    Describes a set of command line arguments, options, and execution behavior. CommandLineApplication can be nested to support subcommands.

    CommandLineApplicationExtensions

    Helper methods for CommandLineApplication.

    CommandOption

    Represents one or many command line option that is identified by flag proceeded by '-' or '--'. Options are not positional. Compare to CommandArgument.

    CommandParsingException

    The exception that is thrown when command line arguments could not be parsed.

    ConsoleExtensions

    Helper methods for IConsole.

    ConsoleReporter

    A thread-safe reporter that forwards to console output.

    DebugHelper

    Helps handle debug command-line arguments.

    DotNetCliContext

    APIs related to .NET Core CLI.

    DotNetExe

    Utilities for finding the "dotnet.exe" file from the currently running .NET Core application.

    HelpOptionAttribute

    The option used to determine if help text should be displayed. This should only be used once per command line app.

    NullConsole

    An implementation of IConsole that does nothing.

    NullReporter

    A reporter that does nothing.

    OptionAttribute

    Represents one or many command line option that is identified by flag proceeded by '-' or '--'. Options are not positional. Compare to ArgumentAttribute.

    OptionAttributeBase

    Common option properties.

    PhysicalConsole

    An implementation of IConsole that wraps System.Console.

    Prompt

    Utilities for getting input from an interactive console.

    SubcommandAttribute

    Represents a subcommand.

    ValidationExtensions

    Extension methods for adding validation rules to options and arguments.

    VersionOptionAttribute

    The option used to determine if help text should be displayed. This should only be used once per command line app.

    Interfaces

    IConsole

    An abstract console.

    IReporter

    Gathers messages with levels.

    Enums

    CommandOptionType

    Defines the kinds of inputs CommandOption accepts.

    ResponseFileHandling

    Specifies options for how to handle response files. The parser treats arguments beginning with '@' as a file path to a response file.

    A response file contains additional arguments that will be treated as if they were passed in on the command line. Response files can have comments that begin with the # symbol. You cannot use the backslash character () to concatenate lines.

    Back to top Generated with docfx