Skip to content

Commit 42f01a8

Browse files
aspire-repo-bot[bot]Copilot
authored andcommitted
docs: update CLI command docs for non-interactive options (aspire#16235)
- aspire update: add --yes/-y and --nuget-config-dir options, remove outdated note that non-interactive mode is unsupported - aspire agent init: add --workspace-root, --skill-locations, and --skills options - aspire new: update description for non-interactive error behavior, add --suppress-agent-init option, remove outdated limitation note Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent b00773e commit 42f01a8

3 files changed

Lines changed: 37 additions & 14 deletions

File tree

‎src/frontend/src/content/docs/reference/cli/commands/aspire-agent-init.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,18 @@ The command performs the following:
3333

3434
The following options are available:
3535

36+
- **`--workspace-root`**
37+
38+
Path to the workspace root directory. When not specified, the current directory is used as the workspace root.
39+
40+
- **`--skill-locations`**
41+
42+
Comma-separated list of skill locations to configure (for example, `vscode,github`). Use `all` to configure all detected locations, or `none` to skip. When not specified, the command prompts interactively.
43+
44+
- **`--skills`**
45+
46+
Comma-separated list of skills to enable (for example, `mcp,cli`). Use `all` to enable all available skills, or `none` to skip. When not specified, the command prompts interactively.
47+
3648
- <Include relativePath="reference/cli/includes/option-help.md" />
3749

3850
- <Include relativePath="reference/cli/includes/option-log-level.md" />

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,7 @@ The `aspire new` command is the driver for creating Aspire projects, apps, or so
2727

2828
This command defaults to **interactive** mode. When executed without any options, the command prompts you for the project template and version, name, and output folder. When the `--name`, `--output`, and `--version` options are provided, the command runs **non-interactive** and generates files based on the command template.
2929

30-
<Aside type="note">
31-
The `aspire new` command currently requires an interactive terminal even when
32-
all options are provided. The `--non-interactive` flag is not fully supported.
33-
In CI/CD pipelines or other non-interactive environments, use `dotnet new`
34-
with Aspire templates as an alternative for project creation.
35-
</Aside>
30+
When run non-interactively without specifying a template subcommand, the command displays an error message listing the available templates.
3631

3732
## Interactive prompts
3833

@@ -104,6 +99,10 @@ The following options are available:
10499

105100
Channel to use for templates (`stable`, `staging`, `daily`).
106101

102+
- **`--suppress-agent-init`**
103+
104+
Suppress the prompt to initialize MCP server configuration for agent environments after project creation.
105+
107106
- <Include relativePath="reference/cli/includes/option-help.md" />
108107

109108
- <Include relativePath="reference/cli/includes/option-log-level.md" />

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

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ import AsciinemaPlayer from '@components/AsciinemaPlayer.astro';
99

1010
import Include from '@components/Include.astro';
1111
import LearnMore from '@components/LearnMore.astro';
12-
import { Aside } from '@astrojs/starlight/components';
1312

1413
## Name
1514

@@ -37,13 +36,6 @@ The command performs the following:
3736
- Validates package compatibility before applying changes
3837
- Provides colorized output with detailed summary of changes
3938

40-
<Aside type="note">
41-
The `aspire update` command requires an interactive terminal. The
42-
`--non-interactive` flag is not currently supported for this command. In CI/CD
43-
pipelines or other non-interactive environments, update Aspire packages
44-
manually using `aspire add {package}` or equivalent tooling.
45-
</Aside>
46-
4739
## Options
4840

4941
The following options are available:
@@ -58,6 +50,14 @@ The following options are available:
5850

5951
Channel to update to (`stable`, `staging`, `daily`).
6052

53+
- **`-y, --yes`**
54+
55+
Automatically confirm all prompts without user input. Use this option in CI/CD pipelines or other non-interactive environments to skip confirmation dialogs.
56+
57+
- **`--nuget-config-dir`**
58+
59+
Path to the directory containing the `NuGet.Config` file to use when searching for packages. When not specified, the command searches for a `NuGet.Config` file in the current directory and its parents.
60+
6161
- <Include relativePath="reference/cli/includes/option-help.md" />
6262

6363
- <Include relativePath="reference/cli/includes/option-log-level.md" />
@@ -83,3 +83,15 @@ The following options are available:
8383
```bash title="Aspire CLI"
8484
aspire update --apphost './projects/apphost/orchestration.AppHost.csproj'
8585
```
86+
87+
- Update packages in a CI/CD pipeline without interactive prompts:
88+
89+
```bash title="Aspire CLI"
90+
aspire update --yes --non-interactive
91+
```
92+
93+
- Update packages using a specific NuGet configuration file:
94+
95+
```bash title="Aspire CLI"
96+
aspire update --nuget-config-dir './config'
97+
```

0 commit comments

Comments
 (0)