Create a class-based command

Implement ICommand

To create a class-based command, you have to create a class that implements the interface MGR.CommandLineParser.Command.ICommand (or inherit CommandBase). The interface provides two members:

  1. a property Arguments (of type IList<string>) that will receive all arguments not mapped to an option,
  2. a method ExecuteAsync (that take no parameters and return a Task<int>) that is called to execute the command. The returned value is the status code that should be returned as exit code.

Inherit from CommandBase

You can inherit from MGR.CommandLineParser.Command.CommandBase. This abstract class provides:

  • implementation of an --help option,
  • access to the current IServiceProvider,
  • access to the current IConsole
  • access to the ICommandType (which describes the current command)

When deriving from this class, you have to implement the ExecuteCommandAsync that is called when the value of the --help option is false.

Customize your command

Learn how to customize your command.

Add options to you command

You can add options to your command by simply adding properties to your class. The properties can have any type, you just have to be sure there is a converter for this type (see the list of built-in converters).

You can customize the behavior of the options with some annotations (the parser supports the annotations from System.ComponentModel.DataAnnotations):

  • Use System.ComponentModel.DataAnnotations.DisplayAttribute and some of its properties:
    • Name and ShortName to respectively change the long and short form of the option
    • Description to define a description in the auto-generated help for the option,
  • Use any of the System.ComponentModel.DataAnnotations.ValidationAttribute derived class to validate the value provided for the option.

See all details about customizing your options.