Update .NET CLI command docs to reflect support for @ symbol#49872
Merged
meaghanlewis merged 4 commits intodotnet:mainfrom Nov 14, 2025
Merged
Update .NET CLI command docs to reflect support for @ symbol#49872meaghanlewis merged 4 commits intodotnet:mainfrom
meaghanlewis merged 4 commits intodotnet:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the .NET CLI command documentation to standardize version specification syntax by introducing support for the @ character (e.g., package@version) while deprecating the older :: separator. The changes span multiple command reference documents to ensure consistency across the documentation.
Key changes:
- Introduces a new include file for workload version parameter documentation
- Updates syntax examples from
::to@across all affected commands - Adds new examples demonstrating the
@syntax for version specification - Updates metadata dates to reflect the documentation revision
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| includes/cli-workload-version.md | New include file defining the workload version parameter with @ syntax support |
| docs/core/tools/dotnet-workload-search.md | Adds workload version parameter to synopsis and new example using @ syntax |
| docs/core/tools/dotnet-workload-install.md | Replaces generic version include with workload-specific version include and adds @ syntax example |
| docs/core/tools/dotnet-tool-update.md | Updates PACKAGE_ID description with @ syntax guidance and adds new examples |
| docs/core/tools/dotnet-tool-install.md | Updates PACKAGE_ID description with @ syntax guidance and adds new examples |
| docs/core/tools/dotnet-new-install.md | Updates description and arguments to document @ syntax and deprecation of ::, updates examples |
gewarren
approved these changes
Nov 13, 2025
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
meaghanlewis
commented
Nov 13, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This pull request updates the .NET CLI documentation to standardize and clarify how package and workload versions are specified, introducing the use of the
@character (e.g.,package@version) across several commands. It also updates documentation examples and descriptions to reflect these changes, and adds new guidance and examples for the updated syntax. The changes aim to improve consistency and make it easier for users to specify versions for templates, tools, and workloads.Key updates by theme:
Standardization of Version Syntax (
@character):dotnet new install,dotnet tool install,dotnet tool update, and workload-related commands to use the@character instead of the deprecated::separator. This change is reflected in command descriptions and examples, with notes about SDK versions where the new syntax is supported.Documentation and Example Updates:
@version syntax for installing and updating templates, tools, and workloads.New and Updated Option Descriptions:
@character for version specification, and referenced the SDK version where this support is available.General Documentation Maintenance:
ms.datefor several documentation files to reflect the latest revision date.Workload Command Improvements:
These changes ensure that users are guided to use the latest and most consistent syntax for specifying versions in .NET CLI commands.
Fixes #46671
Internal previews