Skip to content

Latest commit

 

History

History
54 lines (31 loc) · 2.21 KB

README.md

File metadata and controls

54 lines (31 loc) · 2.21 KB
Raw

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 (more info).

NuGet Version

Installation

dotnet tool install -g AspireRunner.Tool

Usage

aspire-dashboard <options>

Options:
  -b, --browser          Launch the dashboard in the default browser

  -p, --port             (Default: 18888) The port the dashboard will be available on

  -a, --auth             Use browser token authentication for the dashboard

  -s, --https            Use HTTPS instead of HTTP, this applies to both the dashboard and the OTLP server, Enabled by default

  --dashboard-https      Use HTTPS instead of HTTP for the dashboard, overrides the global HTTPS option

  --otlp-port            (Default: 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

  -m, --multiple         Allow running multiple instances of the dashboard, if this isn't passed, existing instances will be replaced

  --auto-update          Automatically update the dashboard to the latest version, Enabled by default

  --dashboard-version    The preferred version of the dashboard to use/download, will fallback to the latest version if it's invalid

  -v, --verbose          Enable verbose logging

  --help                 Display this help screen.

  --version              Display version information.

Note

The runner will download the dashboard to the user's .dotnet directory (~/.dotnet/.AspireRunner).