Dirt.Args is a simple library for parsing command line arguments in .NET.
Its goal is to require no configuration and be a step up from using the built-in string[] args parameter in your Main method.
For more advanced scenarios, you should consider using a more feature-rich library.
Specifically, the following features are not supported:
- Displaying usage
- Validation of parameters
- Commands
- Parsing to anything other than strings
- "Loose" arguments (i.e. associating
barwith the--fooflag in--foo bar)
The library does support the following:
- Boolean Flags (e.g.
--foo) - Key-Value Pairs (e.g.
--foo=bar) - Using
--to separate flags from arguments (e.g.--foo -- --bar) - Counting repeated instances of a flag (e.g.
--foo --foo) - Short flags (e.g.
-f) - Multiple values for a single flag (e.g.
--foo=bar --foo=baz)
var args = new Dirt.Args();
if (args.HasFlag("foo")) {
Console.WriteLine("Foo is set!");
}The IArgs interface exposes the following methods and properties
bool HasFlag(string flag)- Returns true if the flag was setint GetFlagCount(string flag)- Gets the number of times the flag was setstring GetValueFlag(string flag)- Gets the value of the flag, or null if it was not setIReadOnlyList<string> GetMultiValueFlag(string flag)- Gets the values of the flag, or an empty list if it was not setIReadOnlyList<string> Remaining- Any other arguments that are not flags
The Args class explicitly implements these properties from the IArgsData interface to allow access to the underlying data directly:
IReadOnlyDictionary<string, IFlagData> Flags- A dictionary of all flags that were set and their valuesIReadOnlyDictionary<string, string> ValueFlags- A dictionary of all key-value pairs that were setIReadOnlyDictionary<string, IReadOnlyList<string>> MultiValueFlags- A dictionary of all value flags with all their values
The ValueFlags and MultiValueFlags properties are projections of the data exposed by the Flags property.
The IFlagData interface exposes the following properties:
string Flag- The name of the flagint Count- The number of times the flag was setIReadOnlyList<string> Values- The values associated with the flag. This could be empty.
MIT