Skip to content

Commit 40551ce

Browse files
davidfowlCopilot
andauthored
Fix aspire start environment docs (#714)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent b6f2fb2 commit 40551ce

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

src/frontend/src/content/docs/deployment/environments.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The Aspire environment is a single named value — like `Development`, `Staging`
1414

1515
The environment name flows through the system in three stages:
1616

17-
1. **Input**: You pass the environment name to the AppHost. Deployment commands such as `aspire deploy`, `aspire publish`, and `aspire do` expose `--environment` directly, and `aspire start` can forward it to the AppHost with `-- --environment <name>`.
17+
1. **Input**: You pass the environment name to the AppHost. Deployment commands such as `aspire deploy`, `aspire publish`, and `aspire do` expose `--environment` directly, and `aspire start` also accepts `--environment <name>`.
1818
2. **AppHost evaluation**: Your AppHost code reads the environment to branch logic, resolve parameters, or configure resources.
1919
3. **Downstream configuration**: Your AppHost explicitly sets framework-specific environment variables (like `DOTNET_ENVIRONMENT` or `NODE_ENV`) on child resources as needed.
2020

@@ -30,10 +30,10 @@ The environment name flows through the system in three stages:
3030

3131
### During local development
3232

33-
`aspire run` is a development-oriented command, so the AppHost runs in development mode by default. If you want to evaluate a different AppHost environment locally, start the AppHost explicitly and pass the environment through:
33+
`aspire run` is a development-oriented command, so the AppHost runs in development mode by default. If you want to evaluate a different AppHost environment locally, start the AppHost explicitly and specify the environment:
3434

3535
```bash title="Start locally with a staging environment"
36-
aspire start -- --environment Staging
36+
aspire start --environment Staging
3737
```
3838

3939
### During deployment
@@ -59,7 +59,7 @@ The environment name and the execution context are independent concepts:
5959
| Environment | _Where_ is the app targeting? | `Development` | `Production` |
6060
| Execution context | _How_ was the AppHost invoked? | Run mode | Publish mode |
6161

62-
You can start an AppHost locally with `aspire start -- --environment Staging` for validation, or publish to a `Development` cloud environment if your workflow needs that. The two axes are independent — environment names are arbitrary strings, not tied to run vs publish.
62+
You can start an AppHost locally with `aspire start --environment Staging` for validation, or publish to a `Development` cloud environment if your workflow needs that. The two axes are independent — environment names are arbitrary strings, not tied to run vs publish.
6363

6464
## Read the environment in your AppHost
6565

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,10 @@ The following options are available:
8383
aspire start --isolated
8484
```
8585

86-
- Pass additional arguments to the AppHost:
86+
- Start the AppHost with a specific environment:
8787

8888
```bash title="Aspire CLI"
89-
aspire start -- --environment Development
89+
aspire start --environment Development
9090
```
9191

9292
## See also

0 commit comments

Comments
 (0)