From b535f3ac17c21f3fe8cdfc84a2e83a5bf5dcfab7 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 21 Jan 2026 04:28:33 +0000 Subject: [PATCH 1/3] Initial plan From 33a6be418b4e66dfd9353be2b93dea34f54e4d4f Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 21 Jan 2026 04:34:13 +0000 Subject: [PATCH 2/3] Add aspire doctor CLI reference documentation Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --- .../config/sidebar/reference.topics.ts | 4 + .../reference/cli/commands/aspire-doctor.mdx | 121 ++++++++++++++++++ .../docs/reference/cli/commands/aspire.mdx | 1 + 3 files changed, 126 insertions(+) create mode 100644 src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx diff --git a/src/frontend/config/sidebar/reference.topics.ts b/src/frontend/config/sidebar/reference.topics.ts index 43d5b14a..24cb36e5 100644 --- a/src/frontend/config/sidebar/reference.topics.ts +++ b/src/frontend/config/sidebar/reference.topics.ts @@ -256,6 +256,10 @@ export const referenceTopics: StarlightSidebarTopicsUserConfig = { slug: 'reference/cli/commands/aspire-deploy', }, { label: 'aspire do', slug: 'reference/cli/commands/aspire-do' }, + { + label: 'aspire doctor', + slug: 'reference/cli/commands/aspire-doctor', + }, { label: 'aspire exec', slug: 'reference/cli/commands/aspire-exec' }, { label: 'aspire init', slug: 'reference/cli/commands/aspire-init' }, { diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx new file mode 100644 index 00000000..b1336abe --- /dev/null +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx @@ -0,0 +1,121 @@ +--- +title: aspire doctor command +description: Learn about the aspire doctor command and its usage. This command checks the Aspire development environment for common issues. +--- + +import Include from '@components/Include.astro'; +import { Aside } from '@astrojs/starlight/components'; + +## Name + +`aspire doctor` - Check the Aspire development environment for common issues. + +## Synopsis + +```bash title="Aspire CLI" +aspire doctor [options] +``` + +## Description + +The `aspire doctor` command runs a series of diagnostic checks to verify that your development environment is properly configured for Aspire development. It checks prerequisites such as the .NET SDK, container runtime, and environment settings. + +This command is useful for troubleshooting when you encounter issues with Aspire or when setting up a new development environment. The checks are grouped by category: + +- **SDK checks**: Verifies .NET SDK installation and version requirements +- **Container checks**: Validates container runtime (Docker/Podman) availability and configuration +- **Environment checks**: Validates environment variables and other settings + +The command displays results with clear status indicators: + +- ✓ (green) - Check passed +- ⚠ (yellow) - Warning (non-blocking issue) +- ✗ (red) - Check failed (blocking issue) + +If any checks fail, the command provides suggestions for how to fix the issues and links to relevant documentation. + +## Options + +The following options are available: + +- **`--json`** + + Outputs the check results in JSON format. This is useful for automation scenarios or when you need to parse the results programmatically. + +- + +- + +- + +## Examples + +- Run diagnostic checks on your development environment: + + ```bash title="Aspire CLI" + aspire doctor + ``` + +- Run diagnostic checks with JSON output: + + ```bash title="Aspire CLI" + aspire doctor --json + ``` + +## Sample output + +When you run `aspire doctor`, you see output similar to the following: + +```bash title="Aspire CLI" +Environment Check +================= + +SDK +✓ .NET SDK 9.0.100 or later is installed +✓ Aspire templates are available + +Container Runtime +✓ Docker is installed and running +✓ Docker Compose is available + +Environment +✓ ASPNETCORE_ENVIRONMENT is set correctly + +Summary: 5 passed, 0 warnings, 0 failed +``` + +## Exit codes + +The command returns the following exit codes: + +| Exit code | Description | +| --------- | ------------------------------------------------- | +| `0` | All checks passed (warnings are allowed) | +| `1` | One or more checks failed | + +## JSON output format + +When using the `--json` option, the output includes a structured response with all check results and a summary: + +```json +{ + "checks": [ + { + "category": "sdk", + "message": ".NET SDK 9.0.100 or later is installed", + "status": "Pass" + } + ], + "summary": { + "passed": 5, + "warnings": 0, + "failed": 0 + } +} +``` + +## See also + +- [aspire command](../aspire/) +- [aspire run command](../aspire-run/) +- [Aspire CLI overview](../../overview/) diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire.mdx index 866f43a9..0ee19f16 100644 --- a/src/frontend/src/content/docs/reference/cli/commands/aspire.mdx +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire.mdx @@ -46,6 +46,7 @@ The following commands are available: | [`aspire config`](../aspire-config/) | Stable | Configures the Aspire environment. | | [`aspire deploy`](../aspire-deploy/) | Preview | Deploys the artifacts created by `aspire publish`. | | [`aspire do`](../aspire-do/) | Preview | Execute a specific pipeline step and its dependencies. | +| [`aspire doctor`](../aspire-doctor/) | Stable | Check the development environment for common issues. | | [`aspire exec`](../aspire-exec/) | Preview | Similar to the `aspire run` command, but passes commands to the apphost. | | [`aspire init`](../aspire-init/) | Stable | Initialize Aspire support in an existing solution or create a single-file AppHost. | | [`aspire mcp`](../aspire-mcp/) | Stable | Manage MCP (Model Context Protocol) server. | From 08e0dccebdfb545ce3958f40a6606689449d7b95 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 22 Jan 2026 16:32:10 +0000 Subject: [PATCH 3/3] Update .NET SDK version to 10.0.100 in aspire doctor docs Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --- .../src/content/docs/reference/cli/commands/aspire-doctor.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx index b1336abe..db003f0f 100644 --- a/src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx @@ -71,7 +71,7 @@ Environment Check ================= SDK -✓ .NET SDK 9.0.100 or later is installed +✓ .NET SDK 10.0.100 or later is installed ✓ Aspire templates are available Container Runtime @@ -102,7 +102,7 @@ When using the `--json` option, the output includes a structured response with a "checks": [ { "category": "sdk", - "message": ".NET SDK 9.0.100 or later is installed", + "message": ".NET SDK 10.0.100 or later is installed", "status": "Pass" } ],