-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
59 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,42 +1,48 @@ | ||
## AspireRunner | ||
## AspireRunner.Tool | ||
|
||
A dotnet tool for running the Aspire Dashboard that's bundled with the [aspire workload](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/setup-tooling?tabs=dotnet-cli%2Cunix). | ||
A dotnet tool for downloading and running the standalone [Aspire Dashboard](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/dashboard/standalone) | ||
|
||
The dashboard can be used to display OpenTelemetry data (traces, metrics, and logs) from any application ([more info](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/dashboard/overview)) | ||
The dashboard can display OpenTelemetry data (traces, metrics, and logs) from any application ([more info](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/dashboard/overview)). | ||
|
||
[![NuGet Version](https://img.shields.io/nuget/vpre/AspireRunner.Tool?style=flat&logo=nuget&color=%230078d4&link=https%3A%2F%2Fwww.nuget.org%2Fpackages%2FAspireRunner.Tool)](https://www.nuget.org/packages/AspireRunner.Tool) | ||
|
||
## Installation | ||
|
||
```bash | ||
# Install the aspire workload (skip if already installed) | ||
dotnet workload install aspire | ||
|
||
# Install the AspireRunner tool | ||
dotnet tool install -g AspireRunner.Tool | ||
``` | ||
|
||
## Usage | ||
|
||
```bash | ||
``` | ||
aspire-dashboard <options> | ||
Options: | ||
-b, --browser Launch the dashboard in the default browser | ||
-b, --browser Launch the dashboard in the default browser | ||
-p, --port (Default: 18888) The port the dashboard will be available on | ||
-p, --port (Default: 18888) The port the dashboard will be available on | ||
-o, --otlp-port (Default: 4317) The port the OTLP server will listen on | ||
-o, --otlp-port (Default: 4317) The port the OTLP server will listen on | ||
-k, --otlp-key The API key to use for the OTLP server | ||
-k, --otlp-key The API key to use for the OTLP server | ||
-s, --https (Default: true) Use HTTPS instead of HTTP, this applies to both the dashboard and the OTLP server | ||
-s, --https (Default: true) Use HTTPS instead of HTTP, this applies to both the dashboard and the OTLP server | ||
-a, --auth Use browser token authentication for the dashboard | ||
-a, --auth Use browser token authentication for the dashboard | ||
-m, --multiple Allow running multiple instances of the dashboard, if this isn't passed, existing instances will be replaced | ||
-m, --multiple Allow running multiple instances of the dashboard | ||
-r, --runtime-version The version of the .NET runtime to use | ||
--help Display this help screen. | ||
-d, --auto-download (Default: true) Automatically download the dashboard if it's not installed | ||
--version Display version information. | ||
-v, --Verbose Enable verbose logging | ||
--help Display this help screen. | ||
--version Display version information. | ||
``` | ||
|
||
> [!NOTE] | ||
> The runner will prioritize using the dashboard bundled with the [Aspire workload](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/setup-tooling?tabs=windows&pivots=visual-studio), if it's installed. |