Commands.NET 2.0.0-alpha.14

Commands.NET

Consider leaving a ⭐

Do more, with less. With speed, compatibility and fluent integration in mind.

Commands.NET aims to improve your experience integrating input from different sources* into the same, concurrent pool and treating them as triggered actions, called commands. It provides a modular and intuitive API for registering and executing commands.

*Sources can range from command-line, console, chatboxes, to social platforms like Discord, Slack, Messenger & much, much more.

Documentation

Browse the wiki for a full overview of the library.

Installation

Commands.NET is available on NuGet. You can install it using the package manager, or the following command:

dotnet add package Commands.NET
dotnet add package Commands.NET.Hosting

Alternatively, adding it to your .csproj file:

<PackageReference Include="Commands.NET" Version="x.x.x" />
<PackageReference Include="Commands.NET.Hosting" Version="x.x.x" />

The hosting package is optional.

Usage

Running a Command

A command is a method executed when a specific syntax is provided. By creating a manager to contain said command, you can run it with the provided arguments.

using Commands;

var command = Command.From(() => "Hello world!", "greet");

var collection = ComponentCollection.From(command).Create();

await collection.Execute(new ConsoleCallerContext(args));

// dotnet run greet -> Hello world!

Creating Command Groups

Command groups are named collections of commands or other command groups. Groups allow for subcommand creation, where the group name is a category for its children.

using Commands;

var mathCommands = CommandGroup.From("math")
    .AddComponents(
        Command.From((double number, int sumBy)      => number + sumBy, 
            "sum", "add"), 
        Command.From((double number, int subtractBy) => number - subtractBy, 
            "subtract", "sub"), 
        Command.From((double number, int multiplyBy) => number * multiplyBy, 
            "multiply", "mul"), 
        Command.From((double number, int divideBy)   => number / divideBy, 
            "divide", "div")
    );

var collection = ComponentCollection.From(mathCommands).Create();

await collection.Execute(new ConsoleCallerContext(args));

// dotnet run math sum 5 3 -> 8

Creating Command Modules

Command modules are classes that can contain commands or nested command modules, which themselves can also contain (sub)commands.

using Commands;

public class HelpModule : CommandModule 
{
    [Name("help")]
    public void Help()
    {
        var builder = new StringBuilder()
            .AppendLine("Commands:");

        foreach (var command in Manager!.GetCommands())
            builder.AppendLine(command.GetFullName());

        Respond(builder.ToString());
    }
}

...

var collection = ComponentCollection.From(mathCommands).AddType<HelpModule>().Create();

await collection.Execute(new ConsoleCallerContext(args));

// dotnet run help -> Commands: math sum <...> math subtract <...> math ...

Dependency Injection

Commands.NET is designed to be compatible with dependency injection out of the box, propagating IServiceProvider throughout the execution flow.

using Commands;
using Microsoft.Extensions.DependencyInjection;

...

var services = new ServiceCollection()
    .AddSingleton<MyService>()
    .AddSingleton<ComponentCollection>(ComponentCollection.From(mathCommands).AddType<HelpModule>().Create());
    .BuildServiceProvider();

var collection = services.GetRequiredService<ComponentCollection>();

await collection.Execute(new ConsoleCallerContext(args), new CommandOptions() { Services = services });

Modules can be injected directly from the provider. They themselves are considered transient, being created and disposed of per command execution.

public class ServicedModule(MyService service) : CommandModule 
{

}

.NET Generic Host

Alongside dependency injection support in the base package, Commands.NET provides an extension package for the .NET Generic Host, allowing you to integrate Commands.NET into your application with ease.

using Commands.Hosting;
using Microsoft.Extensions.Hosting;

var host = Host.CreateDefaultBuilder(args)
    .ConfigureServices(configure => configure.AddHostedService<CommandListener>())
    .ConfigureComponents(configure => ...)
    .Build();

The extension package supports factory-based command execution alongside scope management, allowing you to manage the lifetime of your commands and modules.

using Commands.Hosting;
using Microsoft.Extensions.Hosting;

public class CommandListener(IExecutionFactory factory) : BackgroundService
{
    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        while (!stoppingToken.IsCancellationRequested)
        {
            var context = new ConsoleCallerContext(Console.ReadLine());

            await factory.StartExecution(context);
        }
    }
}

Samples

• Commands.Samples.Core
  • Manage, create and execute commands in a basic console application.
• Commands.Samples.Console
  • Fluent API's, complex execution flow and workflow expansion.
• Commands.Samples.Hosting
  • Integrating Commands.NET into the .NET Generic Host infrastructure.
• Commands.Samples.FSharp
  • Use Commands.NET in F# projects.

Benchmarks

Benchmark results are found here.