Initial drafts of .NET Aspire CLI docs #3905
Conversation
|
For 9.4, these are the commands and their preview status:
@maddymontaquila to configure status of each command. |
|
I sort of discovered a little discrepency with the |
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the .NET Aspire CLI, including installation guides, command reference pages, and integration into the existing documentation structure. The documentation covers all major CLI commands and provides users with detailed guidance on using the Aspire CLI for project management and deployment.
- Complete CLI documentation including overview, installation, and command reference
- Integration of CLI content into the main documentation TOC
- Addition of CLI installation snippets to existing setup guides
Reviewed Changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/toc.yml | Adds new "Aspire CLI" section with overview, installation, and command reference pages |
| docs/get-started/build-your-first-aspire-app.md | Adds CLI installation instructions with platform-specific commands |
| docs/fundamentals/setup-tooling.md | Adds CLI installation instructions with platform-specific commands |
| docs/cli/overview.md | New overview page explaining CLI functionality and commands |
| docs/cli/install.md | New installation guide for the Aspire CLI global tool |
| docs/cli-reference/*.md | New command reference pages for all CLI commands (aspire, add, config, deploy, etc.) |
| docs/cli-reference/includes/*.md | Shared include files for common CLI options and descriptions |
docs/cli-reference/includes/project-search-logic-description.md
Outdated
Show resolved
Hide resolved
docs/cli-reference/aspire.md
Outdated
| | [`aspire add`](aspire-add.md) | Stable | Add an integration to the Aspire project. | | ||
| | [`aspire new`](aspire-new.md) | Stable | Create an Aspire sample project from a template. | | ||
| | [`aspire run`](aspire-run.md) | Stable | Run an Aspire apphost in development mode. | | ||
| | [`aspire exec`](aspire-exec.md) | Stable | Similar to the `aspire run` command, but passes commands to the apphost. | |
There was a problem hiding this comment.
Is this aspire exec considered stable, I can't recall. @maddymontaquila @davidfowl
|
@mitchdenny give these a look pls! |
| - <xref:Aspire.Hosting.Azure.AzureEnvironmentResource> generates Bicep assets. | ||
| - <xref:Aspire.Hosting.Docker.DockerComposeEnvironmentResource> generates docker-compose yaml. | ||
| - <xref:Aspire.Hosting.Kubernetes.KubernetesEnvironmentResource> generates Kubernetes Helm charts. |
There was a problem hiding this comment.
Related to above comment, it mgiht be better to show concise code examples of AddDocerComposeEnvironment(...). Note that AddKubernetesEnvironment(...) is fairly broken right now.
There was a problem hiding this comment.
Can you provide those code examples? Happy to add them, but need to ensure we're doing it correctly.
| description: Learn about the aspire config set command and its usage. This command sets an Aspire CLI config value by key name. | ||
| ms.date: 07/11/2025 | ||
| --- | ||
| # aspire config set command |
There was a problem hiding this comment.
I think it would be good to have a page which covers off known feature flags (in the Aspire repo there is a KnownFeatures.cs for reference).
There was a problem hiding this comment.
Yes. For now, I just added a table to a section that lists the one command I know is working. I played around with setting those other ones in the config file but it didn't seem to do anything. I added this table to the root aspire config doc and the aspire config set doc.
Co-authored-by: David Pine <[email protected]> Co-authored-by: Copilot <[email protected]>
Co-authored-by: Maddy Montaquila (Leger) <[email protected]>
Fixes #4027
Fixes #4098
Fixes #4026
Fixes #4028
Internal previews
Toggle expand/collapse