Wolfe.FluentCli 1.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Wolfe.FluentCli --version 1.0.0
NuGet\Install-Package Wolfe.FluentCli -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Wolfe.FluentCli" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Wolfe.FluentCli --version 1.0.0
#r "nuget: Wolfe.FluentCli, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Wolfe.FluentCli as a Cake Addin
#addin nuget:?package=Wolfe.FluentCli&version=1.0.0

// Install Wolfe.FluentCli as a Cake Tool
#tool nuget:?package=Wolfe.FluentCli&version=1.0.0

Wolfe.FluentCli

A .NET 5 Fluent API for creating command line interfaces.

Usage

Building the CLI

var cli = FluentCliBuilder.Create()
    // The handler that runs when no command is specified.
    .WithDefaultCommand<DefaultCommandHandler>()
    .AddCommand<HelloCommandHandler>("hello", command => command
        // Options are bound automatically based on property names in snake case.
        .WithOptions<HelloCommandOptions>()
        // Commands can be nested infinitely
        .AddCommand<FooCommandHandler>("foo")
    )
    .Build();

Defining Handlers

// Implement ICommandHandler when you don't have any options.
public class DefaultCommandHandler : ICommandHandler
{
    public Task Execute()
    {
        Console.WriteLine($"Default Handler");
        return Task.CompletedTask;
    }
}

public class HelloCommandOptions
{
    public string FirstName { get; set; }
}

// Implement ICommandHandler<TOptions> when you have configuration.
public class HelloCommandHandler : ICommandHandler<HelloCommandOptions>
{
    public Task Execute(HelloCommandOptions options)
    {
        Console.WriteLine($"Hello {options.FirstName}!");
        return Task.CompletedTask;
    }
}

public class FooCommandHandler : ICommandHandler
{
    public Task Execute()
    {
        Console.WriteLine("Foo");
        return Task.CompletedTask;
    }
}

Executing Commands

// Executes the default command handler
await cli.Execute("");

// Executes the hello command, setting HelloCommandOptions.FirstName to 'Tom'
await cli.Execute("hello --first-name Tom");

// Executes the foo subcommand.
await cli.Execute("hello foo");
Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net5.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.1 447 5/27/2022
2.0.0 395 5/26/2022
1.0.0 429 4/12/2022
0.12.0 420 4/12/2022
0.11.0 325 10/7/2021
0.10.0 304 10/5/2021
0.4.0 493 10/3/2021
0.3.0 387 10/2/2021
0.2.0 349 10/2/2021
0.1.0 315 10/1/2021