Woof.CommandLine 5.0.1

Woof.CommandLine

.NET extension created by CodeDog

Distributed under MIT License. (c)2021 by CodeDog Ltd., All rights reserved.

About

Quick command line parser. Parses command line arguments into parameters and options. An option is an argument starting with a prefix. A parameter is an argument that is not an option. The parameters can be accessed by their positional index. Considering following command line:

text.exe p1 -o1 p2 p3

When we parse the command line to a CommandLine instance c, we can access "p1", "p2" and "p3" strings as c.Parameters[0], c.Parameters[1] and c.Parameters[2]. We can also safely test for c.Parameters[3] - it would be just null.

When we want to test whether the command line contains an option "o1" (that can be also written as "--o1" or "/o1"), that is an alias for name "option1", we can do all that with one simple function: var result = c.HasOption("o1|option1").

Any option can also have value assigned to it with "=" character.

Example:

test.exe -path="C:\Program Files"

In that case, c.Options["path"] would return "C:\Program Files".

Spaces quoting is handled by the system itself. So anything provided with quotes in command line will be passed as unquoted arguments containing spaces. So for the example command line above, the arguments will be just 1 string: "path=c:\Program Files" (without quotes).

Usage

See unit tests for more examples.

Disclaimer

Please report any issues to the toolkit developer.

Woof Toolkit is a work in progress in constant development, however it's carefully maintained with production code quality.

I changed toolkit versioning to 5.x to match the primary .NET 5.0 targetting.