EonaCat.Cli 1.0.0

EonaCat.Cli

Easily create Cli commands and a help menu using EonaCat.Cli.

var parser = new CliParser()
            .AddOption(new CliOption("help", 'h', description: "Show help", valueType: typeof(bool)))
            .AddOption(new CliOption("name", 'n', isRequired: true, description: "Name of user"))
            .AddOption(new CliOption("count", 'c', description: "Number of times", valueType: typeof(int), defaultValue: 1, validator: val =>
            {
                if (int.TryParse(val.ToString(), out var i))
                    return i > 0;
                return false;
            }))
            .AddOption(new CliOption("verbose", 'v', description: "Verbose output", valueType: typeof(bool)))
            .AddOption(new CliOption("files", 'f', description: "Input files", allowsMultiple: true));

        // Add a sample subcommand "greet"
        parser.AddCommand(new CliCommand(
            "greet",
            "Greet the user",
            new List<CliOption>
            {
                new CliOption("name", 'n', true, description: "Name to greet"),
                new CliOption("count", 'c', description: "Number of greetings", valueType: typeof(int), defaultValue: 1)
            },
            async (result) =>
            {
                if (result.HasFlag("help"))
                {
                    Console.WriteLine("Usage: greet --name <name> [--count <num>]");
                    return;
                }

                string name = result.Get<string>("name");
                int count = result.Get<int>("count");

                for (int i = 0; i < count; i++)
                {
                    Console.WriteLine($"Hello, {name}!");
                    await Task.Delay(100);
                }
            }));

        try
        {
            await parser.ParseAndRunAsync(args);
        }
        catch (ArgumentException ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
            Console.WriteLine(parser.GetHelpText());
        }
    }

Running help for the greet command:

dotnet run -- greet --help

Outputs:

Usage: greet --name <name> [--count <num>]
Options:
  --name, -n <name>       Name to greet
  --count, -c <num>       Number of greetings (default: 1)

Running the greet command:

dotnet run -- greet --name Alice --count 3

Outputs:

Hello, Alice!
Hello, Alice!
Hello, Alice!

Running without any arguments (prints general help):

dotnet run

Outputs:

Commands:
  greet  -  Greet the user

Options:
    -h, --help  Show help
    -n, --name <string> (required)  Name of user
    -c, --count <int>  Number of times
    -v, --verbose  Verbose output
    -f, --files [multiple]  Input files

dotnet run unknowncmd

dotnet run unknowncmd

Outputs:

Unknown command 'unknowncmd'. Available commands:
greet

Running greet missing required option name:

dotnet run greet

Outputs:

Error: Missing required options: --name
Usage: greet --name <name> [--count <num>]