CommandDotNet

A modern framework for building modern CLI apps

Programming language: C#

License: MIT License

Tags: CLI    

Latest version: v1.3

README

CommandDotNet

A modern framework for building modern CLI apps

Out of the box support for commands, sub-commands, validations, dependency injection, piping and streaming, enums & custom types, typo suggestions, prompting, passwords, response files and much more! See the features page.

Favors POSIX conventions

Includes [test tools](TestTools/overview.md) used by the framework to test all features of the framework.

Modify and extend the functionality of the framework through configuration and middleware.

Documentation 👉 https://commanddotnet.bilal-fazlani.com

Support

For bugs, create an issue

For questions and feature requests, start a discussion

For a quick walkthrough of features, see our Getting Started guides

Here's a starter:

Example

Begin by creating the commands:

<!-- snippet: getting-started-100-calculator -->

public class Program
{
    // this is the entry point of your application
    static int Main(string[] args)
    {
        // AppRunner<T> where T is the class defining your commands
        // You can use Program or create commands in another class
        return new AppRunner<Program>().Run(args);
    }

    // Add command with two positional arguments
    public void Add(int x, int y) => Console.WriteLine(x + y);

    // Subtract command with two positional arguments
    public void Subtract(int x, int y) => Console.WriteLine(x - y);
}

snippet source | anchor <!-- endSnippet -->

That's it. You now have an applciation with two commands. Let's see about how we can call it from command line.

Assuming our application's name is calculator.dll, let's run this app from command line using dotnet. First we'll check out the auto-generated help.

<!-- snippet: getting-started-100-calculator-help -->

$ dotnet calculator.dll --help
Usage: dotnet calculator.dll [command]

Commands:

  Add
  Subtract

Use "dotnet calculator.dll [command] --help" for more information about a command.

snippet source | anchor <!-- endSnippet -->

From the root we can see the available commands. Instead of --help we could have used -h or -?. We'll use -h to get help for the Add command.

<!-- snippet: getting-started-100-calculator-add-help -->

$ dotnet calculator.dll Add -h
Usage: dotnet calculator.dll Add <x> <y>

Arguments:

  x  <NUMBER>

  y  <NUMBER>

snippet source | anchor <!-- endSnippet -->

Let's try it out by adding two numbers

<!-- snippet: getting-started-100-calculator-add -->

$ dotnet calculator.dll Add 40 20
60

snippet source | anchor <!-- endSnippet -->

CommandDotNet will validate if the arguments can be converted to the correct type.

<!-- snippet: getting-started-100-calculator-add-invalid -->

$ dotnet calculator.dll Add a 20
'a' is not a valid Number

snippet source | anchor <!-- endSnippet -->

Check out the docs for more examples

See our Getting Started guides to see how to improve the help documentation, test the application and utilize the many other features of CommandDotNet.

Credits 🎉

Special thanks to Drew Burlingame for continuous support and contributions