Skip to content

[docs] Update aspire run/stop graceful shutdown documentation #1291

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.

Sign up for GitHub

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
IEvangelist merged 4 commits into from
Jul 23, 2026
+15 −2
Merged

[docs] Update aspire run/stop graceful shutdown documentation #1291

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
318d782
docs: update aspire run/stop graceful shutdown docs for #17814
aspire-repo-bot[bot] Jun 23, 2026
f861bc1
docs: remove resource/AppHost shutdown conflation from aspire run and…
Copilot Jul 22, 2026
cbc5b0a
Merge branch 'origin/release/13.5' into fix-graceful-shutdown-docs-17…
Copilot Jul 22, 2026
ad8bc1c
Update aspire-run.mdx
IEvangelist Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions src/frontend/src/content/docs/reference/cli/commands/aspire-run.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description: Learn about the aspire run command, which builds and runs an Aspire
---

import Include from '@components/Include.astro';
import { Steps } from '@astrojs/starlight/components';
import { Kbd } from 'starlight-kbd/components';

## Name
Expand Down Expand Up @@ -35,9 +36,21 @@ The command performs the following steps to run an Aspire AppHost:

## Stopping the AppHost

To stop the running AppHost and exit, press <Kbd windows="Ctrl+C" mac="⌃+C" linux="Ctrl+C" /> (or send `SIGTERM` on Linux/macOS). The CLI requests a graceful shutdown of the AppHost and its resources. If shutdown takes longer than a moment, a `🛑 Stopping Aspire.` message is displayed shortly after you press <Kbd windows="Ctrl+C" mac="⌃+C" linux="Ctrl+C" /> to confirm that shutdown is in progress.
To stop the running AppHost and exit, press <Kbd windows="Ctrl+C" mac="⌃+C" linux="Ctrl+C" /> (or send `SIGTERM` on Linux/macOS). The shutdown follows a three-step sequence. If shutdown takes longer than a moment, a `🛑 Stopping Aspire.` message is displayed shortly after you press <Kbd windows="Ctrl+C" mac="⌃+C" linux="Ctrl+C" /> to confirm that shutdown is in progress.

If graceful shutdown is taking too long and you need to exit immediately, press <Kbd windows="Ctrl+C" mac="⌃+C" linux="Ctrl+C" /> a second time to terminate the process immediately.
<Steps>

1. **Cooperative cancellation** — The CLI requests that the AppHost stop gracefully.
2. **Graceful wait** — The CLI waits for the AppHost process to exit cleanly on its own.
3. **Automatic force-kill** — If the AppHost does not exit within the graceful timeout, the CLI terminates the process automatically.

</Steps>

If graceful shutdown is taking too long and you need to exit immediately, press <Kbd windows="Ctrl+C" mac="⌃+C" linux="Ctrl+C" /> a second time. This collapses the graceful window and starts the force-kill sequence immediately.

:::note
On Windows, TypeScript/JavaScript AppHosts started with `tsx` or `npm` run in an isolated console session so that the Ctrl+C signal is delivered correctly to the Node.js process rather than to an unrelated foreground window.
:::

## Hot Reload and watch behavior

Expand Down
Loading