-
Notifications
You must be signed in to change notification settings - Fork 75
Add aspire doctor CLI reference documentation #270
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
121 changes: 121 additions & 0 deletions
121
src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx
This file contains hidden or 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 |
|---|---|---|
| @@ -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. | ||
|
|
||
| - <Include relativePath="reference/cli/includes/option-help.md" /> | ||
|
|
||
| - <Include relativePath="reference/cli/includes/option-debug.md" /> | ||
|
|
||
| - <Include relativePath="reference/cli/includes/option-wait.md" /> | ||
|
|
||
| ## 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/) | ||
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.