orc.commandline's Introduction

Orc.CommandLine

Use command line the easy way.

Quick introduction

Using this library is easy:

public class MyContext : ContextBase
{
    [Option(' ', "", HelpText = "The file name to start with")]
    public string FileName { get; set; }

    [Option('b', "bool", AcceptsValue = false, HelpText = "Some boolean switch")]
    public bool BooleanSwitch { get; set; }

    [Option('i', "int", HelpText = "Some integer switch")]
    public int IntegerSwitch { get; set; }

    [Option('s', "string", HelpText = "Some string switch")]
    public string StringSwitch { get; set; }
}

Then use this code:

var commandLine = Environment.CommandLine;
var context = new MyContext();

var validationContext = commandLineParser.Parse(commandLine, context);
if (validationContext.HasErrors)
{
    // something bad happened
    return;
}

if (context.IsHelp)
{
    // Use the IHelpWriterService to output the help
    var helpContent = helpWriterService.ConvertToString(context);
    // TODO: write to console or show as a message box
    return;
}

// Handle the context here

This will successfully parse a command line like this:

myapp.exe somefile /b -string somestring /i 42

Allowed switches

The library supports 2 types of switches, / and -. For example:

-b
-string
/b
/string

An option definition has a short and long name. Both can be used as a switch.

Accepts value

The AcceptsValue property should only be used on boolean properties. When they are specified, they are assumed to be true (defaulting to false).

Recommend Projects