AspireRunner.Tool 2.0.2

AspireRunner.Tool

A dotnet tool for downloading and running the standalone Aspire Dashboard.

The dashboard can display OpenTelemetry data (traces, metrics, and logs) from any application. However, the dotnet tool is specifically intended for use during local development and testing

Installation

dotnet tool install -g AspireRunner.Tool

Usage

<img width="650" height="374.31906614786" alt="Screenshot" src="https://github.com/user-attachments/assets/f7ee6ec9-f2de-4f4f-9bb6-b085f49e1109" />

Run command

aspire-dashboard [run] [ARGUMENTS] [OPTIONS]

ARGUMENTS:
    [version]    The version of the dashboard to run

OPTIONS:
                             DEFAULT
    -h, --help                            Prints help information
    -v, --version                         Prints version information
    -b, --browser                         Launch the dashboard in the default browser
    -p, --port               18888        The port the dashboard will be available on
    -a, --auth                            Use browser token authentication for the dashboard
    -t, --token                           The token to use for dashboard authentication, if not passed, the token will be randomly generated by the dashboard
    -s, --https              True         Use HTTPS instead of HTTP, this applies to both the dashboard and the OTLP server
        --dashboard-https                 Use HTTPS instead of HTTP for the dashboard, overrides the global HTTPS option
        --otlp-port          4317         The port the OTLP/gRPC server will listen on, can be disabled by passing 0
        --otlp-http-port                  The port the OTLP/HTTP server will listen on, by default, only the gRPC server is started
        --otlp-key                        The API key to use for the OTLP server
        --otlp-https                      Use HTTPS instead of HTTP for the OTLP/gRPC and OTLP/HTTP endpoints, overrides the global HTTPS option
        --cors-origins                    The allowed origins for CORS requests, separated by a comma. A wildcard (*) can be used to allow any domain
        --cors-headers                    The allowed headers for CORS requests, separated by a comma
        --hostname           localhost    The hostname used for the dashboard and OTLP server
    -m, --multiple                        Allow running multiple instances of the dashboard, if not passed, existing instances will be replaced
        --auto-update        True         Automatically update the dashboard to the latest version
        --verbose                         Enable verbose logging

Install command

aspire-dashboard install [version] [OPTIONS]

ARGUMENTS:
    [version]    The version of the dashboard to install, pass 'latest' to install the latest version available

OPTIONS:
    -h, --help                Prints help information
    -p, --allow-prerelease    Allow prerelease versions when installing

Uninstall command

aspire-dashboard uninstall [version] [OPTIONS]

ARGUMENTS:
    [version]    The version of the dashboard to uninstall, pass 'all' or '*' to uninstall all versions

OPTIONS:
    -h, --help    Prints help information

Cleanup command

Removes old versions of the dashboard and other temporary files

aspire-dashboard cleanup