Monarch 4.0.0

dotnet add package Monarch --version 4.0.0                
NuGet\Install-Package Monarch -Version 4.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="Monarch" Version="4.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Monarch --version 4.0.0                
#r "nuget: Monarch, 4.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 Monarch as a Cake Addin
#addin nuget:?package=Monarch&version=4.0.0

// Install Monarch as a Cake Tool
#tool nuget:?package=Monarch&version=4.0.0                

Monarch

.NET Publish Coverage Status

Monarch is a command line parser/task runner.

Basic Usage

In order to use the system, you need to register it with your ServiceCollection:

serviceCollection.RegisterMonarch();

Or if you are using Canister:

serviceCollection.AddCanisterModules();
				

This is required prior to using the Monarch class for the first time. Once it is wired up, you can use the CommandRunner class:

var Instance = new CommandRunner();
return Instance.Run(args);

The CommandRunner class has a Run method which parses the args passed in and runs the appropriate command. The library has help and version commands built in to the system, however to create your own commands you need to create a command and also an input class:

public class TestCommand : CommandBaseClass<TestInput>
{
    public override string[] Aliases => new string[] { "Test" };

    public override string Description => "Test command";

    public override string Name => "Test Command";

    protected override async Task<int> Run(TestInput input)
    {
        await Task.CompletedTask;
        Console.WriteLine(input.Value1);
        Console.WriteLine(input.Value2);
        Console.WriteLine(input.Value3.ToString(x => x));
        return 0;
    }
}

public class TestInput
{
    [Display(Description = "Value 1 Property")]
    public int Value1 { get; set; }

    [Display(Description = "Value 2 Property")]
    public string Value2 { get; set; }

    [Display(Description = "Value 3 Property")]
    [MaxLength(3)]
    public List<string> Value3 { get; set; }
}

The command above inherits from the CommandBaseClass and defines the input that it expects. In this case TestInput. TestInput is how the command line arguments should be parsed by the system. The commands must define the aliases, description, and name for the command. The TestInput then defines properties and uses the DisplayAttribute from the System.ComponentModel.DataAnnotations namespace to define information. Also any data annotations defining max length, required, etc. are used to validate the input.

Options

By default the system does not require you to set options. However you can specify some options found within the system including command prefix, flag prefix, and indentation amount. In order to override what is in the system just create a class that inherits from IOptions:

public class DefaultOptions : IOptions
{
    /// <summary>
    /// Gets the command prefix.
    /// </summary>
    /// <value>The command prefix.</value>
    public string CommandPrefix { get; } = "";

    /// <summary>
    /// Gets the flag prefix.
    /// </summary>
    /// <value>The flag prefix.</value>
    public string FlagPrefix { get; } = "-";

    /// <summary>
    /// Gets the indent amount.
    /// </summary>
    /// <value>The indent amount.</value>
    public int IndentAmount { get; } = 4;
}
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Monarch:

Package Downloads
TaskMaster

TaskMaster is a simple library used to manage sets of fire and forget tasks that need to run after specific dates/times.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.0.0 332 2 months ago
3.0.116 162 2 months ago
3.0.115 121 2 months ago
3.0.114 124 2 months ago
3.0.113 125 2 months ago
3.0.112 120 2 months ago
3.0.111 173 2 months ago
3.0.110 135 2 months ago
3.0.109 128 2 months ago
3.0.108 90 2 months ago
3.0.107 122 2 months ago
3.0.106 233 3 months ago
3.0.105 131 3 months ago
3.0.104 407 4 months ago
3.0.103 201 4 months ago
3.0.102 146 4 months ago
3.0.101 146 5 months ago
3.0.100 206 5 months ago
3.0.99 161 5 months ago
3.0.98 173 5 months ago
3.0.97 199 5 months ago
3.0.96 189 5 months ago
3.0.95 170 6 months ago
3.0.94 177 6 months ago
3.0.93 249 6 months ago
3.0.92 149 7 months ago
3.0.91 181 7 months ago
3.0.90 163 7 months ago
3.0.89 164 7 months ago
3.0.88 150 7 months ago
3.0.87 161 7 months ago
3.0.86 156 7 months ago
3.0.85 199 7 months ago
3.0.84 207 7 months ago
3.0.83 173 8 months ago
3.0.82 138 8 months ago
3.0.81 190 8 months ago
3.0.80 170 8 months ago
3.0.79 172 8 months ago
3.0.78 161 8 months ago
3.0.77 112 8 months ago
3.0.76 127 8 months ago
3.0.75 153 8 months ago
3.0.74 162 8 months ago
3.0.73 232 9 months ago
3.0.72 115 9 months ago
3.0.71 155 9 months ago
3.0.70 203 9 months ago
3.0.69 157 9 months ago
3.0.68 217 10 months ago
3.0.67 160 10 months ago
3.0.66 155 10 months ago
3.0.65 181 3/11/2024
3.0.64 176 3/8/2024
3.0.63 159 3/7/2024
3.0.62 156 3/6/2024
3.0.61 141 3/5/2024
3.0.60 124 3/4/2024
3.0.59 279 2/29/2024
3.0.58 157 2/28/2024
3.0.57 158 2/26/2024
3.0.56 186 2/23/2024
3.0.55 147 2/22/2024
3.0.54 126 2/21/2024
3.0.53 280 2/15/2024
3.0.52 181 2/12/2024
3.0.51 192 2/8/2024
3.0.50 154 2/7/2024
3.0.49 167 2/6/2024
3.0.48 200 2/1/2024
3.0.47 258 1/24/2024
3.0.46 132 1/23/2024
3.0.45 257 1/11/2024
3.0.44 330 12/19/2023
3.0.43 184 12/14/2023
3.0.42 154 12/13/2023
3.0.41 311 11/24/2023
3.0.40 211 11/21/2023
3.0.39 149 11/20/2023
3.0.38 178 11/17/2023
3.0.37 192 11/16/2023
3.0.36 165 11/15/2023
3.0.35 258 11/9/2023
3.0.34 200 11/7/2023
3.0.33 160 11/6/2023
3.0.32 249 11/1/2023
3.0.31 167 10/31/2023
3.0.30 174 10/30/2023
3.0.29 207 10/26/2023
3.0.28 220 10/12/2023
3.0.27 264 9/26/2023
3.0.26 175 9/20/2023
3.0.25 179 9/19/2023
3.0.24 172 9/18/2023
3.0.23 213 9/14/2023
3.0.22 181 9/13/2023
3.0.21 184 9/12/2023
3.0.20 187 9/11/2023
3.0.19 224 9/7/2023
3.0.18 182 9/6/2023
3.0.17 175 9/5/2023
3.0.16 183 9/4/2023
3.0.15 201 9/1/2023
3.0.14 185 8/31/2023
3.0.13 186 8/30/2023
3.0.12 197 8/29/2023
3.0.11 200 8/28/2023
3.0.10 240 8/23/2023
3.0.9 237 8/18/2023
3.0.8 232 8/16/2023
3.0.7 215 8/9/2023
3.0.6 213 8/8/2023
3.0.5 148 8/8/2023
3.0.4 224 8/7/2023
3.0.3 230 8/4/2023
3.0.2 300 7/26/2023
3.0.1 303 7/14/2023
3.0.0 425 12/12/2022
2.0.16 452 6/10/2022
2.0.14 314 1/11/2022
2.0.13 1,337 1/11/2022
2.0.12 787 1/10/2022
2.0.10 658 6/21/2021
2.0.8 366 6/21/2021
2.0.6 696 1/6/2021
2.0.5 1,047 9/13/2020
2.0.4 753 3/29/2020
2.0.3 1,051 3/25/2020
2.0.2 801 3/3/2020
2.0.1 1,480 12/31/2019
2.0.0 1,009 12/23/2019
1.0.7 1,125 8/31/2018
1.0.6 777 8/31/2018
1.0.5 782 8/31/2018