Geek Answers Handbook

Run command line with subcommands in C #

Is there a command line parsing library for C # with good support for git, svn, etc. subcommands, etc.? For example, the git command has several subcommands:

git add git status git diff ...

There are global parameters that must precede the name of the subcommand, as well as parameters related to the subcommand that should follow its name. For example, they do different things:

 git -p add git add -p

Different subcommands may have different options and arguments.

I use NDesk.Options, but so far I have not had to execute subcommands. I think it’s flexible enough to create subcommands from above, but it’s not entirely obvious how best to do this in a concise and elegant manner. Is it possible to do this in NDesk.Options or is there a more suitable C # command line parsing library?

+4
source share
2 answers

I am not the only one in my own options parsing library that I currently have . I plan to cover the subcommands, but it will be a while before I get to it (this will be one of the last posts).

Nito.KitchenSink.OptionParsing does not support sub-commands directly, but you can use the library to parse only parts of the command line and process the sub-commands yourself. The options "global" and "sub-command-specific" add an interesting twist, but this can be done as follows:

 using System; using System.Linq; using Nito.KitchenSink.OptionParsing; class Program { private sealed class GlobalOptions : OptionArgumentsBase { // Use a better name than "POption". This is just an example. [Option('p', OptionArgument.None)] public bool POption { get; set; } // Override Validate to allow AdditionalArguments. public override void Validate() { } } private sealed class AddOptions : OptionArgumentsBase { [Option('p', OptionArgument.None)] public bool POption { get; set; } } static int Main() { try { // Parse the entire command line into a GlobalOptions object. var options = OptionParser.Parse<GlobalOptions>(); // The first entry in AdditionalArguments is our sub-command. if (options.AdditionalArguments.Count == 0) throw new OptionParsingException("No sub-command specified."); object subcommandOptions = null; string subcommand = options.AdditionalArguments[0]; switch (subcommand) { case "add": { // Parse the remaining arguments as command-specific options. subcommandOptions = OptionParser.Parse<AddOptions>(options.AdditionalArguments.Skip(1)); break; } case "status": // TODO: Parse command-specific options for this, too. break; case "diff": // TODO: Parse command-specific options for this, too. break; default: throw new OptionParsingException("Unknown sub-command: " + subcommand); } // At this point, we have our global options, subcommand, and subcommand options. Console.WriteLine("Global -p option: " + options.POption); Console.WriteLine("Subcommand: " + subcommand); var addOptions = subcommandOptions as AddOptions; if (addOptions != null) Console.WriteLine("Add-specific -p option: " + addOptions.POption); return 0; } catch (OptionParsingException ex) { Console.Error.WriteLine(ex.Message); // TODO: write out usage information. return 2; } catch (Exception ex) { Console.Error.WriteLine(ex); return 1; } } }

The sample program above gives the following output:

 >CommandLineParsingTest.exe No sub-command specified. >CommandLineParsingTest.exe -p No sub-command specified. >CommandLineParsingTest.exe test Unknown sub-command: test >CommandLineParsingTest.exe add Global -p option: False Subcommand: add Add-specific -p option: False >CommandLineParsingTest.exe -p add Global -p option: True Subcommand: add Add-specific -p option: False >CommandLineParsingTest.exe add -p Global -p option: False Subcommand: add Add-specific -p option: True >CommandLineParsingTest.exe -p add -p Global -p option: True Subcommand: add Add-specific -p option: True >CommandLineParsingTest.exe status Global -p option: False Subcommand: status >CommandLineParsingTest.exe -p status Global -p option: True Subcommand: status
+2
source

You can try the open source command line project:

http://commandline.codeplex.com/

0
source

More articles:


All Articles