Skip to content

Clarify worktree and same-path behavior for --isolated in the CLI reference #2184

Open

Description

@adamint

Clarify worktree and same-path behavior for --isolated in the CLI reference

Target: microsoft/aspire.dev

The --isolated descriptions on both reference pages say:

Run in isolated mode with randomized ports and isolated user secrets, allowing multiple instances of the same AppHost to run simultaneously.

Neither explains that those instances must come from different directories, such as separate worktrees/checkouts. That intended contract has now been confirmed.

In a local test, aspire start --apphost apphost.cs --isolated --no-build --non-interactive --format Json stopped the existing VS Code-debugged instance at that path before starting its replacement. This was on macOS with Aspire SDK 17.0.0. We haven't separately reproduced two concurrent foreground aspire run --isolated commands.

Update both reference pages:

  • Say that parallel isolated runs require copies of the same AppHost in different directories, typically separate worktrees/checkouts.
  • Explain what happens when the same command is repeated from the same path.
  • Distinguish run, start, and run --detach if their behavior differs.
  • Include a concrete supported side-by-side example.

Suggested wording:

Run with randomized ports and isolated user secrets, allowing copies of the same AppHost in different directories, such as separate Git worktrees, to run simultaneously. This does not enable multiple concurrent instances from the same AppHost path.

These pages contain their own checked-in descriptions in:

  • src/frontend/src/content/docs/reference/cli/commands/aspire-run.mdx
  • src/frontend/src/content/docs/reference/cli/commands/aspire-start.mdx

Updating CLI help alone won't update this prose. Keep the wording aligned with the corresponding microsoft/aspire clarification.

Related CLI-help follow-up: microsoft/aspire#22344 covers the command help wording.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions