From 17aa488e86b8bcaa89d66f7ab1e6ab6e263f03d1 Mon Sep 17 00:00:00 2001 From: Meaghan Osagie Date: Mon, 29 Sep 2025 16:08:15 -0700 Subject: [PATCH 1/7] Add new command reference articles --- docs/core/tools/dotnet-package-update | 54 ++++++++++++++++++++++ docs/core/tools/dotnet-workload-clean.md | 42 +++++++++++++++++ docs/core/tools/dotnet-workload-history.md | 42 +++++++++++++++++ docs/core/tools/dotnet.md | 5 ++ docs/core/tools/index.md | 2 + docs/navigate/tools-diagnostics/toc.yml | 6 +++ 6 files changed, 151 insertions(+) create mode 100644 docs/core/tools/dotnet-package-update create mode 100644 docs/core/tools/dotnet-workload-clean.md create mode 100644 docs/core/tools/dotnet-workload-history.md diff --git a/docs/core/tools/dotnet-package-update b/docs/core/tools/dotnet-package-update new file mode 100644 index 0000000000000..950da3baca65f --- /dev/null +++ b/docs/core/tools/dotnet-package-update @@ -0,0 +1,54 @@ +--- +title: dotnet package update command +description: The dotnet package update command provides a convenient option to update a NuGet package reference to a project. +ms.date: 09/29/2025 +--- +# dotnet package update + +**This article applies to:** ✔️ .NET 6 and later versions + +## Name + +`dotnet package update` - Updates referenced packages in a project or solution. + +> [!NOTE] +> If you're using .NET 9 SDK or earlier, use the "verb first" form (`dotnet update package`) instead. The "noun first" form was introduced in .NET 10. For more information, see [More consistent command order](../whats-new/dotnet-10/sdk.md#more-consistent-command-order). + +## Synopsis + +```dotnetcli +dotnet package update [--project ] [--interactive] [-v|--verbosity ] +dotnet package update -h|--help +``` + +## Description + +The `dotnet package update` command provides a convenient option to update a NuGet package reference in a project or solution. + +## Arguments + +`PACKAGE_NAME` + +The package reference to update. + +## Options + +- **`-p|--project `** + + The project file to operate on. If a solution file is specified, the command will update the package in all projects in the solution that reference it. If not specified, the command will search the current directory for a project file. + +[!INCLUDE [interactive](../../../includes/cli-interactive.md)] + +- **`-v|--verbosity `** + + Sets the verbosity level of the command. Allowed values are `q[uiet]`, `m[inimal]`, `n[ormal]`, `d[etailed]`, and `diag[nostic]`. The default is `normal`. + +[!INCLUDE [help](../../../includes/cli-help.md)] + +## Examples + +- Update `Microsoft.Extensions.Logging` NuGet package from a project in the current directory: + + ```dotnetcli + dotnet package update Microsoft.Extensions.Logging + ``` diff --git a/docs/core/tools/dotnet-workload-clean.md b/docs/core/tools/dotnet-workload-clean.md new file mode 100644 index 0000000000000..c776af6dcfded --- /dev/null +++ b/docs/core/tools/dotnet-workload-clean.md @@ -0,0 +1,42 @@ +--- +title: dotnet workload clean command +description: "The `dotnet workload clean` command removes workload components that may have been left behind from previous updates and uninstallations." +ms.date: 09/29/2025 +--- +# dotnet workload clean + +**This article applies to:** ✔️ .NET 6 SDK and later versions + +## Name + +`dotnet workload clean` - Removes workload components that may have been left behind from previous updates and uninstallations. + +## Synopsis + +```dotnetcli +dotnet workload clean [options] + +dotnet workload clean -?|-h|--help +``` + +## Description + +The `dotnet workload clean` command removes all workload components that have been uninstalled. + +For more information about the `dotnet workload` commands, see the [dotnet workload install](dotnet-workload-install.md#description) command. + +## Options + +- **--all** + + Removes and uninstalls all workload components from all SDK versions. Defaults to `false`. + +[!INCLUDE [help](../../../includes/cli-help.md)] + +## Examples + +- Remove all workflow components: + + ```dotnetcli + dotnet workload clean --all + ``` diff --git a/docs/core/tools/dotnet-workload-history.md b/docs/core/tools/dotnet-workload-history.md new file mode 100644 index 0000000000000..1b2bea7e79091 --- /dev/null +++ b/docs/core/tools/dotnet-workload-history.md @@ -0,0 +1,42 @@ +--- +title: dotnet workload history command +description: "The `dotnet workload history` command shows a history of workload installation actions." +ms.date: 09/29/2025 +--- +# dotnet workload history + +**This article applies to:** ✔️ .NET 6 SDK and later versions + +## Name + +`dotnet workload history` - Shows a history of workload installation actions. + +## Synopsis + +```dotnetcli +dotnet workload history [options] + +dotnet workload history -?|-h|--help +``` + +## Description + +The `dotnet workload history` shows a history of workload installation actions. + +For more information about the `dotnet workload` commands, see the [dotnet workload install](dotnet-workload-install.md#description) command. + +## Options + +- **--all** + + Removes and uninstalls all workload components from all SDK versions. Defaults to `false`. + +[!INCLUDE [help](../../../includes/cli-help.md)] + +## Examples + +- Remove all workflow components: + + ```dotnetcli + dotnet workload history --all + ``` diff --git a/docs/core/tools/dotnet.md b/docs/core/tools/dotnet.md index 03cfa024da649..faf5a3c374da6 100644 --- a/docs/core/tools/dotnet.md +++ b/docs/core/tools/dotnet.md @@ -198,6 +198,7 @@ The following options are available only when `dotnet` runs an application by us | [dotnet package list](dotnet-package-list.md) | Lists NuGet packages. | | [dotnet package remove](dotnet-package-remove.md) | Removes a NuGet package. | | [dotnet package search](dotnet-package-search.md) | Searches for a NuGet package. | +| [dotnet package update](dotnet-package-update.md) | Updates a NuGet package. | ### NuGet commands @@ -217,9 +218,13 @@ The following options are available only when `dotnet` runs an application by us | Command | Function | |---------------------------------------------------------|-----------------------------------------------------| +| [dotnet workload clean](dotnet-workload-clean.md) | Removes workload components. | +| [dotnet workload config](dotnet-workload-config.md) | Enables or disables workload-set update mode. | +| [dotnet workload history](dotnet-workload-history) | Shows all workload installation actions. | | [dotnet workload install](dotnet-workload-install.md) | Installs an optional workload. | | [dotnet workload list](dotnet-workload-list.md) | Lists all installed workloads. | | [dotnet workload repair](dotnet-workload-repair.md) | Repairs all installed workloads. | +| [dotnet workload restore](dotnet-workload-restore.md) | Restore workloads required for a project. | | [dotnet workload search](dotnet-workload-search.md) | List selected workloads or all available workloads. | | [dotnet workload uninstall](dotnet-workload-install.md) | Uninstalls a workload. | | [dotnet workload update](dotnet-workload-update.md) | Reinstalls all installed workloads. | diff --git a/docs/core/tools/index.md b/docs/core/tools/index.md index 33c8da824c4bc..4b31fb1886706 100644 --- a/docs/core/tools/index.md +++ b/docs/core/tools/index.md @@ -102,8 +102,10 @@ The following commands are installed by default: ### Workload management commands - [`workload`](dotnet-workload.md) (Available since .NET 7 SDK) +- [`workload clean`](dotnet-workload-clean) (Available since .NET 6 SDK) - [`workload config`](dotnet-workload-config.md) (Available since .NET 8.0.400 SDK) - [`workload install`](dotnet-workload-install.md) (Available since .NET 6 SDK) +- [`workload history`](dotnet-workload-history) (Available since .NET 6 SDK) - [`workload list`](dotnet-workload-list.md) (Available since .NET 6 SDK) - [`workload update`](dotnet-workload-update.md) (Available since .NET 6 SDK) - [`workload restore`](dotnet-workload-restore.md) (Available since .NET 6 SDK) diff --git a/docs/navigate/tools-diagnostics/toc.yml b/docs/navigate/tools-diagnostics/toc.yml index 52b37667a3956..c72c493f85f7e 100644 --- a/docs/navigate/tools-diagnostics/toc.yml +++ b/docs/navigate/tools-diagnostics/toc.yml @@ -190,6 +190,8 @@ items: href: ../../core/tools/dotnet-package-remove.md - name: dotnet package search href: ../../core/tools/dotnet-package-search.md + - name: dotnet package update + href: ../../core/tools/dotnet-package-update.md - name: dotnet publish href: ../../core/tools/dotnet-publish.md - name: dotnet reference add/list/remove @@ -239,8 +241,12 @@ items: href: ../../core/tools/dotnet-workload.md - name: dotnet workload sets href: ../../core/tools/dotnet-workload-sets.md + - name: dotnet workload clean + href: ../../core/tools/dotnet-workload-clean.md - name: dotnet workload config href: ../../core/tools/dotnet-workload-config.md + - name: dotnet workload history + href: ../../core/tools/dotnet-workload-history.md - name: dotnet workload install href: ../../core/tools/dotnet-workload-install.md - name: dotnet workload list From 098f3b229529475861607b19cd4a8e2a96b1c454 Mon Sep 17 00:00:00 2001 From: Meaghan Osagie Date: Mon, 29 Sep 2025 16:19:05 -0700 Subject: [PATCH 2/7] fix file extensions and links --- .../tools/{dotnet-package-update => dotnet-package-update.md} | 0 docs/core/tools/dotnet.md | 2 +- docs/core/tools/index.md | 4 ++-- 3 files changed, 3 insertions(+), 3 deletions(-) rename docs/core/tools/{dotnet-package-update => dotnet-package-update.md} (100%) diff --git a/docs/core/tools/dotnet-package-update b/docs/core/tools/dotnet-package-update.md similarity index 100% rename from docs/core/tools/dotnet-package-update rename to docs/core/tools/dotnet-package-update.md diff --git a/docs/core/tools/dotnet.md b/docs/core/tools/dotnet.md index faf5a3c374da6..73fb9a8c955b5 100644 --- a/docs/core/tools/dotnet.md +++ b/docs/core/tools/dotnet.md @@ -220,7 +220,7 @@ The following options are available only when `dotnet` runs an application by us |---------------------------------------------------------|-----------------------------------------------------| | [dotnet workload clean](dotnet-workload-clean.md) | Removes workload components. | | [dotnet workload config](dotnet-workload-config.md) | Enables or disables workload-set update mode. | -| [dotnet workload history](dotnet-workload-history) | Shows all workload installation actions. | +| [dotnet workload history](dotnet-workload-history.md) | Shows all workload installation actions. | | [dotnet workload install](dotnet-workload-install.md) | Installs an optional workload. | | [dotnet workload list](dotnet-workload-list.md) | Lists all installed workloads. | | [dotnet workload repair](dotnet-workload-repair.md) | Repairs all installed workloads. | diff --git a/docs/core/tools/index.md b/docs/core/tools/index.md index 4b31fb1886706..6db287bb181b3 100644 --- a/docs/core/tools/index.md +++ b/docs/core/tools/index.md @@ -102,10 +102,10 @@ The following commands are installed by default: ### Workload management commands - [`workload`](dotnet-workload.md) (Available since .NET 7 SDK) -- [`workload clean`](dotnet-workload-clean) (Available since .NET 6 SDK) +- [`workload clean`](dotnet-workload-clean.md) (Available since .NET 6 SDK) - [`workload config`](dotnet-workload-config.md) (Available since .NET 8.0.400 SDK) - [`workload install`](dotnet-workload-install.md) (Available since .NET 6 SDK) -- [`workload history`](dotnet-workload-history) (Available since .NET 6 SDK) +- [`workload history`](dotnet-workload-history.md) (Available since .NET 6 SDK) - [`workload list`](dotnet-workload-list.md) (Available since .NET 6 SDK) - [`workload update`](dotnet-workload-update.md) (Available since .NET 6 SDK) - [`workload restore`](dotnet-workload-restore.md) (Available since .NET 6 SDK) From 16b7d4ad85916a0efa37442147d4eb1e8d1f4307 Mon Sep 17 00:00:00 2001 From: Meaghan Osagie Date: Thu, 2 Oct 2025 15:18:12 -0700 Subject: [PATCH 3/7] Update dotnet package documentation --- docs/core/tools/dotnet-package-update.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/core/tools/dotnet-package-update.md b/docs/core/tools/dotnet-package-update.md index 950da3baca65f..76d234335a375 100644 --- a/docs/core/tools/dotnet-package-update.md +++ b/docs/core/tools/dotnet-package-update.md @@ -5,7 +5,7 @@ ms.date: 09/29/2025 --- # dotnet package update -**This article applies to:** ✔️ .NET 6 and later versions +**This article applies to:** ✔️ .NET 6 SDK and later versions ## Name @@ -39,9 +39,7 @@ The package reference to update. [!INCLUDE [interactive](../../../includes/cli-interactive.md)] -- **`-v|--verbosity `** - - Sets the verbosity level of the command. Allowed values are `q[uiet]`, `m[inimal]`, `n[ormal]`, `d[etailed]`, and `diag[nostic]`. The default is `normal`. +[!INCLUDE [verbosity](../../../includes/cli-verbosity-normal.md)] [!INCLUDE [help](../../../includes/cli-help.md)] From fc1690edd264767da2b26120f4f995c0deda400c Mon Sep 17 00:00:00 2001 From: "Meaghan Osagie (Lewis)" Date: Fri, 3 Oct 2025 09:59:05 -0700 Subject: [PATCH 4/7] Update docs/core/tools/dotnet-package-update.md Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- docs/core/tools/dotnet-package-update.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/core/tools/dotnet-package-update.md b/docs/core/tools/dotnet-package-update.md index 76d234335a375..99b53f2c5824d 100644 --- a/docs/core/tools/dotnet-package-update.md +++ b/docs/core/tools/dotnet-package-update.md @@ -35,7 +35,7 @@ The package reference to update. - **`-p|--project `** - The project file to operate on. If a solution file is specified, the command will update the package in all projects in the solution that reference it. If not specified, the command will search the current directory for a project file. + The project file to operate on. If a solution file is specified, the command updates the package in all projects in the solution that reference it. If not specified, the command searches the current directory for a project file. [!INCLUDE [interactive](../../../includes/cli-interactive.md)] From 65763cc3346bb34632dfe64a04a693b4eeec0d54 Mon Sep 17 00:00:00 2001 From: "Meaghan Osagie (Lewis)" Date: Fri, 3 Oct 2025 09:59:14 -0700 Subject: [PATCH 5/7] Update docs/core/tools/dotnet-workload-clean.md Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- docs/core/tools/dotnet-workload-clean.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/core/tools/dotnet-workload-clean.md b/docs/core/tools/dotnet-workload-clean.md index c776af6dcfded..9b17857875714 100644 --- a/docs/core/tools/dotnet-workload-clean.md +++ b/docs/core/tools/dotnet-workload-clean.md @@ -1,6 +1,6 @@ --- title: dotnet workload clean command -description: "The `dotnet workload clean` command removes workload components that may have been left behind from previous updates and uninstallations." +description: "The `dotnet workload clean` command removes workload components that might have been left behind from previous updates and uninstallations." ms.date: 09/29/2025 --- # dotnet workload clean From ce51a0f76b98aff88a27b0d0838732ff74ad0a60 Mon Sep 17 00:00:00 2001 From: "Meaghan Osagie (Lewis)" Date: Fri, 3 Oct 2025 09:59:21 -0700 Subject: [PATCH 6/7] Update docs/core/tools/dotnet-workload-clean.md Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- docs/core/tools/dotnet-workload-clean.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/core/tools/dotnet-workload-clean.md b/docs/core/tools/dotnet-workload-clean.md index 9b17857875714..ced1eddec136e 100644 --- a/docs/core/tools/dotnet-workload-clean.md +++ b/docs/core/tools/dotnet-workload-clean.md @@ -9,7 +9,7 @@ ms.date: 09/29/2025 ## Name -`dotnet workload clean` - Removes workload components that may have been left behind from previous updates and uninstallations. +`dotnet workload clean` - Removes workload components that might have been left behind from previous updates and uninstallations. ## Synopsis From a56b64bc29ae072531520bd78711d5c76441fae9 Mon Sep 17 00:00:00 2001 From: Meaghan Osagie Date: Fri, 3 Oct 2025 10:18:44 -0700 Subject: [PATCH 7/7] remove dotnet-package-update and references --- docs/core/tools/dotnet-package-update.md | 52 ------------------------ docs/core/tools/dotnet.md | 1 - docs/navigate/tools-diagnostics/toc.yml | 4 +- 3 files changed, 1 insertion(+), 56 deletions(-) delete mode 100644 docs/core/tools/dotnet-package-update.md diff --git a/docs/core/tools/dotnet-package-update.md b/docs/core/tools/dotnet-package-update.md deleted file mode 100644 index 99b53f2c5824d..0000000000000 --- a/docs/core/tools/dotnet-package-update.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: dotnet package update command -description: The dotnet package update command provides a convenient option to update a NuGet package reference to a project. -ms.date: 09/29/2025 ---- -# dotnet package update - -**This article applies to:** ✔️ .NET 6 SDK and later versions - -## Name - -`dotnet package update` - Updates referenced packages in a project or solution. - -> [!NOTE] -> If you're using .NET 9 SDK or earlier, use the "verb first" form (`dotnet update package`) instead. The "noun first" form was introduced in .NET 10. For more information, see [More consistent command order](../whats-new/dotnet-10/sdk.md#more-consistent-command-order). - -## Synopsis - -```dotnetcli -dotnet package update [--project ] [--interactive] [-v|--verbosity ] -dotnet package update -h|--help -``` - -## Description - -The `dotnet package update` command provides a convenient option to update a NuGet package reference in a project or solution. - -## Arguments - -`PACKAGE_NAME` - -The package reference to update. - -## Options - -- **`-p|--project `** - - The project file to operate on. If a solution file is specified, the command updates the package in all projects in the solution that reference it. If not specified, the command searches the current directory for a project file. - -[!INCLUDE [interactive](../../../includes/cli-interactive.md)] - -[!INCLUDE [verbosity](../../../includes/cli-verbosity-normal.md)] - -[!INCLUDE [help](../../../includes/cli-help.md)] - -## Examples - -- Update `Microsoft.Extensions.Logging` NuGet package from a project in the current directory: - - ```dotnetcli - dotnet package update Microsoft.Extensions.Logging - ``` diff --git a/docs/core/tools/dotnet.md b/docs/core/tools/dotnet.md index 73fb9a8c955b5..b77d496cf5150 100644 --- a/docs/core/tools/dotnet.md +++ b/docs/core/tools/dotnet.md @@ -198,7 +198,6 @@ The following options are available only when `dotnet` runs an application by us | [dotnet package list](dotnet-package-list.md) | Lists NuGet packages. | | [dotnet package remove](dotnet-package-remove.md) | Removes a NuGet package. | | [dotnet package search](dotnet-package-search.md) | Searches for a NuGet package. | -| [dotnet package update](dotnet-package-update.md) | Updates a NuGet package. | ### NuGet commands diff --git a/docs/navigate/tools-diagnostics/toc.yml b/docs/navigate/tools-diagnostics/toc.yml index c72c493f85f7e..df66783c62fb3 100644 --- a/docs/navigate/tools-diagnostics/toc.yml +++ b/docs/navigate/tools-diagnostics/toc.yml @@ -189,9 +189,7 @@ items: - name: dotnet package remove href: ../../core/tools/dotnet-package-remove.md - name: dotnet package search - href: ../../core/tools/dotnet-package-search.md - - name: dotnet package update - href: ../../core/tools/dotnet-package-update.md + href: ../../core/tools/dotnet-package-search.md - name: dotnet publish href: ../../core/tools/dotnet-publish.md - name: dotnet reference add/list/remove