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

Open
aspire-repo-bot wants to merge 1 commit into
base: release/13.5
Choose a base branch
from
+11 −3
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 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 @@ -35,9 +35,17 @@ 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.
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 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.
1. **Cooperative cancellation** — The CLI requests that the AppHost stop gracefully. Resources receive cancellation signals and begin their own cleanup.
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.

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
2 changes: 1 addition & 1 deletion src/frontend/src/content/docs/reference/cli/commands/aspire-stop.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ When executed without the `--apphost` option, the command:
3. If only one AppHost is running in scope, stops it directly.
4. If no in-scope AppHosts are found but out-of-scope AppHosts exist, displays all running AppHosts for selection.

The command sends a stop signal to the CLI process that started the AppHost, which ensures a clean shutdown of all resources including the dashboard and any containers or processes that were started.
The command sends a graceful stop signal to the running AppHost process, which ensures a clean shutdown of all resources including the dashboard and any containers or processes that were started.

## Options

Expand Down
Loading