README.md

Heap

Heap helps you manage all of your CLI options

Contents

• Heap
  • Contents
  • How to use Heap
  • Invalid parsing

How to use Heap

Heap intends to be a super simple, no thrills Command Line arguments parser. It's as easy to use as:

void Main(string[] args)
{
    var options = Heap.Crush(args).Into<ConfigurationOptions>();

    // ...
}

private class ConfigurationOptions(bool enableFeatureA);

When users interact with the above program, all they would need to provide when running it in their command line arguments is: --enableFeatureA true

Invalid parsing

If Heap fails to parse the input into its property, then it will set it to the default value.

For example (using the ConfigurationOptions type from above):

--enableFeatureA "22"

will set ConfigurationOptions.enableFeatureA to false.