Quick Start

Get a JasperFx-enabled application running in under a minute.

Minimal Setup

Create a new console application and install JasperFx:

dotnet new console -n MyApp
cd MyApp
dotnet add package JasperFx

Replace the contents of Program.cs:

await Host
    .CreateDefaultBuilder()
    .ApplyJasperFxExtensions()
    .RunJasperFxCommands(args);

^{snippet source | anchor}

Running Commands

With this setup you immediately get access to built-in commands:

# Show all available commands
dotnet run -- help

# Describe the application configuration
dotnet run -- describe

# Run environment checks
dotnet run -- check-env

Adding Custom Commands

You can register your own commands by creating classes that extend JasperFxCommand<T> or JasperFxAsyncCommand<T>. See Writing Commands for details.

Adding Environment Checks

Register checks to verify your application's external dependencies at startup:

public static void RegisterChecks(IServiceCollection services)
{
    // Async check with IServiceProvider access
    services.CheckEnvironment(
        "Database is reachable",
        async (IServiceProvider sp, CancellationToken ct) =>
        {
            // Throw an exception to indicate failure
            await Task.CompletedTask;
        });

    // Synchronous check
    services.CheckEnvironment(
        "Configuration file exists",
        (IServiceProvider sp) =>
        {
            if (!File.Exists("appsettings.json"))
            {
                throw new FileNotFoundException("Missing configuration file");
            }
        });
}

^{snippet source | anchor}

What Next?

• Writing Commands -- Create custom CLI commands
• Environment Checks -- Validate your runtime environment
• Configuration -- Configure JasperFx options