Aspire.Cli
13.4.6
Prefix Reserved
dotnet tool install --global Aspire.Cli --version 13.4.6
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
dotnet tool install --local Aspire.Cli --version 13.4.6
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Aspire.Cli&version=13.4.6
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package Aspire.Cli --version 13.4.6
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Aspire CLI
The Aspire CLI is used to create, run, and manage Aspire-based distributed applications.
Usage
aspire <command> [options]
Global Options
| Option | Description |
|---|---|
-h, /h |
Show help and usage information. |
-v, --version |
Show version information. |
-l, --log-level |
Set the minimum log level for console output (Trace, Debug, Information, Warning, Error, Critical). |
--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 executing the command. |
Commands
App Commands
| Command | Description |
|---|---|
new |
Create a new app from an Aspire starter template. |
init |
Initialize Aspire in an existing codebase. |
add [<integration>] |
Add a hosting integration to the apphost. |
update |
Update integrations in the Aspire project. |
run |
Run an apphost in development mode. |
stop |
Stop a running apphost or the specified resource. |
ps |
List running apphosts. |
Resource Management
| Command | Description |
|---|---|
start <resource> |
Start a stopped resource. |
stop [<resource>] |
Stop a running apphost or the specified resource. |
restart <resource> |
Restart a running resource. |
wait <resource> |
Wait for a resource to reach a target status. |
command <resource> <command> |
Execute a command on a resource. |
Monitoring
| Command | Description |
|---|---|
describe [<resource>] |
Describe resources in a running apphost. |
logs [<resource>] |
Display logs from resources in a running apphost. |
otel |
View OpenTelemetry data (logs, spans, traces) from a running apphost. |
Deployment
| Command | Description |
|---|---|
publish |
Generate deployment artifacts for an apphost. |
deploy |
Deploy an apphost to its deployment targets. |
destroy |
Destroy a previously deployed AppHost environment. |
do <step> |
Execute a specific pipeline step and its dependencies. |
Tools & Configuration
| Command | Description |
|---|---|
config |
Manage CLI configuration including feature flags. |
cache |
Manage disk cache for CLI operations. |
doctor |
Diagnose Aspire environment issues and verify setup. |
docs |
Browse and search Aspire documentation and API reference from aspire.dev. |
agent |
Manage AI agent specific setup. |
Examples
# Create a new Aspire application
aspire new
# Run the apphost
aspire run
# Start in the background (useful for CI and agent environments)
aspire start --isolated
# Check resource status
aspire describe
# Stream resource state changes
aspire describe --follow
# View logs
aspire logs
aspire logs webapi
# Stop the apphost
aspire stop
# Wait for a resource to be healthy (CI/scripts)
aspire start
aspire wait webapi --timeout 60
# Add an integration
aspire add redis
# Diagnose environment issues
aspire doctor
# Search the API reference
aspire docs api search "RunAsEmulator" --language csharp
# Search Aspire documentation
aspire docs search "redis"
Additional documentation
Feedback & contributing
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.
| Version | Downloads | Last Updated |
|---|---|---|
| 13.4.6 | 49,120 | 6/19/2026 |
| 13.4.5 | 9,190 | 6/17/2026 |
| 13.4.4 | 6,305 | 6/15/2026 |
| 13.4.3 | 22,450 | 6/8/2026 |
| 13.4.2 | 12,397 | 6/3/2026 |
| 13.4.1 | 437 | 6/3/2026 |
| 13.4.0 | 6,515 | 6/1/2026 |
| 13.3.5 | 23,311 | 5/21/2026 |
| 13.3.4 | 3,229 | 5/19/2026 |
| 13.3.3 | 5,767 | 5/15/2026 |
| 13.3.2 | 2,337 | 5/14/2026 |
| 13.3.1 | 6,776 | 5/12/2026 |
| 13.3.0 | 5,625 | 5/7/2026 |
| 13.2.4 | 31,041 | 4/24/2026 |
| 13.2.3 | 4,866 | 4/21/2026 |
| 13.2.2 | 19,547 | 4/8/2026 |
| 13.2.1 | 9,983 | 3/31/2026 |
| 13.2.0 | 14,153 | 3/23/2026 |
| 13.1.3 | 3,503 | 3/19/2026 |
| 13.1.2 | 17,987 | 2/26/2026 |
Loading failed