aspire dashboard run command

Ce contenu n’est pas encore disponible dans votre langue.

Name

aspire dashboard run - Start the Aspire dashboard.

Synopsis

aspire dashboard run [options]

Description

The aspire dashboard run command starts a standalone Aspire Dashboard instance. The dashboard receives OpenTelemetry data (logs, traces, and metrics) and provides a web-based UI for viewing telemetry.

By default, the dashboard frontend is served at http://localhost:18888, the OTLP/gRPC endpoint listens on http://localhost:4317, and the OTLP/HTTP endpoint listens on http://localhost:4318. All endpoints can be customized using the options below.

The dashboard is secured with a browser token by default. When the dashboard starts, a login URL with the token is displayed in the terminal. Use --allow-anonymous to disable authentication during local development. For more details, see Dashboard security considerations.

Any additional arguments not recognized by the CLI are forwarded directly to the dashboard process, allowing you to pass dashboard configuration settings (for example, --Dashboard:TelemetryLimits:MaxLogCount=5000).

Options

The following options are available:

--frontend-url <url> One or more HTTP endpoints through which the dashboard frontend is served. Default: http://localhost:18888.
--otlp-grpc-url <url> The OTLP/gRPC endpoint. This endpoint hosts an OTLP service and receives telemetry using gRPC. Default: http://localhost:4317.
--otlp-http-url <url> The OTLP/HTTP endpoint. This endpoint hosts an OTLP service and receives telemetry using Protobuf over HTTP. Default: http://localhost:4318.
--allow-anonymous Allow anonymous access to the dashboard. When not specified, the dashboard is secured with a browser token for the frontend and an API key for the telemetry API.
--config-file-path <path> The path for a JSON configuration file.
-?, -h, --help

Prints help and usage documentation for the available commands and options.
-l, --log-level <Critical|Debug|Error|Information|None|Trace|Warning>

Set the minimum log level for console output. Use this option to increase diagnostics while troubleshooting or reduce output in scripted runs.
--non-interactive

Run the command in non-interactive mode, disabling all interactive prompts and spinners.
--nologo

Suppress the startup banner and telemetry notice.
--banner

Display the animated Aspire CLI welcome banner.
--wait-for-debugger

Wait for a debugger to attach before running a command.

Examples

Start the dashboard with default settings:
Aspire CLI
```
aspire dashboard run
```

Start the dashboard on a custom port:

aspire dashboard run --frontend-url http://localhost:9000

Start with custom OTLP endpoints:

aspire dashboard run --otlp-grpc-url http://localhost:14317 --otlp-http-url http://localhost:14318

Start with anonymous access (local development only):
Aspire CLI
```
aspire dashboard run --allow-anonymous
```

Start with a JSON configuration file:

aspire dashboard run --config-file-path ./dashboard-config.json