-
Notifications
You must be signed in to change notification settings - Fork 72
[docs] Document aspire start readiness diagnostics and failure output #1002
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
Open
aspire-repo-bot
wants to merge
4
commits into
release/13.4
Choose a base branch
from
docs/aspire-start-readiness-v2-1d85e261444a0e33
base: release/13.4
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
4cffb7b
docs: document aspire start readiness diagnostics and failure output
aspire-repo-bot[bot] 174f95f
Potential fix for pull request finding
adamint 79553e4
docs: replace ellipsis with <log-path> placeholder in sample output b…
Copilot 14c9152
docs: standardize AppHost casing and switch to bash code fences
Copilot 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,13 @@ | ||
| --- | ||
| title: aspire start command | ||
| description: Learn about the aspire start command and its usage. This command starts an apphost in the background. | ||
| description: Learn about the aspire start command and its usage. This command starts an AppHost in the background. | ||
| --- | ||
|
|
||
| import Include from '@components/Include.astro'; | ||
|
|
||
| ## Name | ||
|
|
||
| `aspire start` - Start an apphost in the background. | ||
| `aspire start` - Start an AppHost in the background. | ||
|
|
||
| ## Synopsis | ||
|
|
||
|
|
@@ -17,12 +17,47 @@ aspire start [options] [[--] <additional arguments>...] | |
|
|
||
| ## Description | ||
|
|
||
| The `aspire start` command starts an AppHost in the background and exits after the apphost is running. Use it when you want a detached apphost that you can inspect later with commands such as `aspire ps`, `aspire describe`, `aspire logs`, and `aspire stop`. | ||
| The `aspire start` command starts an AppHost in the background and exits after the AppHost reaches a stable running state. Use it when you want a detached AppHost that you can inspect later with commands such as `aspire ps`, `aspire describe`, `aspire logs`, and `aspire stop`. | ||
|
|
||
| <Include relativePath="reference/cli/includes/project-search-logic-description.md" /> | ||
|
|
||
| You can output detached startup details as a table or JSON, and you can pass additional arguments through to the AppHost by using the `--` delimiter. | ||
|
|
||
| ### Startup readiness and failure diagnostics | ||
|
|
||
| `aspire start` waits for the AppHost to report that it has reached a stable running state before detaching. This means that early startup failures — such as TypeScript syntax errors in a polyglot AppHost or C# compile errors in a .NET AppHost — are surfaced in the parent terminal instead of being silently lost in the background. | ||
|
|
||
| When the AppHost fails to start, `aspire start` displays a curated excerpt of the startup output that filters out noise such as package install logs and highlights the relevant error messages: | ||
|
|
||
| ```bash title="Aspire CLI" | ||
| Starting Aspire AppHost in the background... | ||
| ❌ Failed to start the AppHost. | ||
| ℹ️ Recent AppHost startup output: | ||
| apphost.ts(1,15): error TS1109: Expression expected. | ||
| ❌ AppHost process exited with code 2. | ||
| 📄 See logs at <log-path> | ||
| ``` | ||
|
Comment on lines
+37
to
+39
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @copilot implement this fix
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done — replaced both |
||
|
|
||
| For a .NET AppHost with a compile error, the output includes the relevant build diagnostics: | ||
|
|
||
| ```bash title="Aspire CLI" | ||
| Starting Aspire AppHost in the background... | ||
| ❌ Failed to start the AppHost. | ||
| ℹ️ Recent AppHost startup output: | ||
| Determining projects to restore... | ||
| All projects are up-to-date for restore. | ||
| /work/MyAppHost/Program.cs(3,41): error CS1002: ; expected [/work/MyAppHost/MyAppHost.csproj] | ||
| Build FAILED. | ||
| 0 Warning(s) | ||
| 1 Error(s) | ||
| ❌ AppHost failed to build. | ||
| 📄 See logs at <log-path> | ||
| ``` | ||
|
|
||
| The parent log also captures the replayed child output under `DetachedAppHost/...` log categories so the log file is self-contained. | ||
|
|
||
| Pressing **Ctrl+C** while `aspire start` is waiting for the AppHost to start will terminate the startup process. | ||
|
|
||
| ## Hot Reload and watch behavior | ||
|
|
||
| By default, `aspire start` starts the AppHost as a detached background process. It doesn't watch the AppHost or resource source files. After you change AppHost code, restart the detached AppHost by running `aspire start` again. For individual resource changes, keep the AppHost running and restart or rebuild the resource from the Aspire CLI or dashboard when needed. | ||
|
|
@@ -51,7 +86,7 @@ The following options are available: | |
|
|
||
| - **`--format <Json|Table>`** | ||
|
|
||
| Output format for detached apphost results. Use `Json` for machine-readable output suitable for scripting and automation. | ||
| Output format for detached AppHost results. Use `Json` for machine-readable output suitable for scripting and automation. | ||
|
|
||
| - **`--isolated`** | ||
|
|
||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot implement this fix. standardize to AppHost
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Standardized to "AppHost" (PascalCase) in frontmatter description, Name section, and Options section in commit 14c9152.