Skip to content

Commit 17aa488

Browse files
meaghanlewismeaghanlewis
committed
Add new command reference articles
1 parent 36487da commit 17aa488

File tree

6 files changed

+151
-0
lines changed

6 files changed

+151
-0
lines changed

‎docs/core/tools/dotnet-package-update‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: dotnet package update command
3+
description: The dotnet package update command provides a convenient option to update a NuGet package reference to a project.
4+
ms.date: 09/29/2025
5+
---
6+
# dotnet package update
7+
8+
**This article applies to:** ✔️ .NET 6 and later versions
9+
10+
## Name
11+
12+
`dotnet package update` - Updates referenced packages in a project or solution.
13+
14+
> [!NOTE]
15+
> 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).
16+
17+
## Synopsis
18+
19+
```dotnetcli
20+
dotnet package update <PACKAGE_NAME> [--project <PROJECT>] [--interactive] [-v|--verbosity <LEVEL>]
21+
dotnet package update -h|--help
22+
```
23+
24+
## Description
25+
26+
The `dotnet package update` command provides a convenient option to update a NuGet package reference in a project or solution.
27+
28+
## Arguments
29+
30+
`PACKAGE_NAME`
31+
32+
The package reference to update.
33+
34+
## Options
35+
36+
- **`-p|--project <PROJECT>`**
37+
38+
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.
39+
40+
[!INCLUDE [interactive](../../../includes/cli-interactive.md)]
41+
42+
- **`-v|--verbosity <LEVEL>`**
43+
44+
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`.
45+
46+
[!INCLUDE [help](../../../includes/cli-help.md)]
47+
48+
## Examples
49+
50+
- Update `Microsoft.Extensions.Logging` NuGet package from a project in the current directory:
51+
52+
```dotnetcli
53+
dotnet package update Microsoft.Extensions.Logging
54+
```

‎docs/core/tools/dotnet-workload-clean.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: dotnet workload clean command
3+
description: "The `dotnet workload clean` command removes workload components that may have been left behind from previous updates and uninstallations."
4+
ms.date: 09/29/2025
5+
---
6+
# dotnet workload clean
7+
8+
**This article applies to:** ✔️ .NET 6 SDK and later versions
9+
10+
## Name
11+
12+
`dotnet workload clean` - Removes workload components that may have been left behind from previous updates and uninstallations.
13+
14+
## Synopsis
15+
16+
```dotnetcli
17+
dotnet workload clean [options]
18+
19+
dotnet workload clean -?|-h|--help
20+
```
21+
22+
## Description
23+
24+
The `dotnet workload clean` command removes all workload components that have been uninstalled.
25+
26+
For more information about the `dotnet workload` commands, see the [dotnet workload install](dotnet-workload-install.md#description) command.
27+
28+
## Options
29+
30+
- **--all**
31+
32+
Removes and uninstalls all workload components from all SDK versions. Defaults to `false`.
33+
34+
[!INCLUDE [help](../../../includes/cli-help.md)]
35+
36+
## Examples
37+
38+
- Remove all workflow components:
39+
40+
```dotnetcli
41+
dotnet workload clean --all
42+
```

‎docs/core/tools/dotnet-workload-history.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: dotnet workload history command
3+
description: "The `dotnet workload history` command shows a history of workload installation actions."
4+
ms.date: 09/29/2025
5+
---
6+
# dotnet workload history
7+
8+
**This article applies to:** ✔️ .NET 6 SDK and later versions
9+
10+
## Name
11+
12+
`dotnet workload history` - Shows a history of workload installation actions.
13+
14+
## Synopsis
15+
16+
```dotnetcli
17+
dotnet workload history [options]
18+
19+
dotnet workload history -?|-h|--help
20+
```
21+
22+
## Description
23+
24+
The `dotnet workload history` shows a history of workload installation actions.
25+
26+
For more information about the `dotnet workload` commands, see the [dotnet workload install](dotnet-workload-install.md#description) command.
27+
28+
## Options
29+
30+
- **--all**
31+
32+
Removes and uninstalls all workload components from all SDK versions. Defaults to `false`.
33+
34+
[!INCLUDE [help](../../../includes/cli-help.md)]
35+
36+
## Examples
37+
38+
- Remove all workflow components:
39+
40+
```dotnetcli
41+
dotnet workload history --all
42+
```

‎docs/core/tools/dotnet.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,7 @@ The following options are available only when `dotnet` runs an application by us
198198
| [dotnet package list](dotnet-package-list.md) | Lists NuGet packages. |
199199
| [dotnet package remove](dotnet-package-remove.md) | Removes a NuGet package. |
200200
| [dotnet package search](dotnet-package-search.md) | Searches for a NuGet package. |
201+
| [dotnet package update](dotnet-package-update.md) | Updates a NuGet package. |
201202

202203
### NuGet commands
203204

@@ -217,9 +218,13 @@ The following options are available only when `dotnet` runs an application by us
217218

218219
| Command | Function |
219220
|---------------------------------------------------------|-----------------------------------------------------|
221+
| [dotnet workload clean](dotnet-workload-clean.md) | Removes workload components. |
222+
| [dotnet workload config](dotnet-workload-config.md) | Enables or disables workload-set update mode. |
223+
| [dotnet workload history](dotnet-workload-history) | Shows all workload installation actions. |
220224
| [dotnet workload install](dotnet-workload-install.md) | Installs an optional workload. |
221225
| [dotnet workload list](dotnet-workload-list.md) | Lists all installed workloads. |
222226
| [dotnet workload repair](dotnet-workload-repair.md) | Repairs all installed workloads. |
227+
| [dotnet workload restore](dotnet-workload-restore.md) | Restore workloads required for a project. |
223228
| [dotnet workload search](dotnet-workload-search.md) | List selected workloads or all available workloads. |
224229
| [dotnet workload uninstall](dotnet-workload-install.md) | Uninstalls a workload. |
225230
| [dotnet workload update](dotnet-workload-update.md) | Reinstalls all installed workloads. |

‎docs/core/tools/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,10 @@ The following commands are installed by default:
102102
### Workload management commands
103103

104104
- [`workload`](dotnet-workload.md) (Available since .NET 7 SDK)
105+
- [`workload clean`](dotnet-workload-clean) (Available since .NET 6 SDK)
105106
- [`workload config`](dotnet-workload-config.md) (Available since .NET 8.0.400 SDK)
106107
- [`workload install`](dotnet-workload-install.md) (Available since .NET 6 SDK)
108+
- [`workload history`](dotnet-workload-history) (Available since .NET 6 SDK)
107109
- [`workload list`](dotnet-workload-list.md) (Available since .NET 6 SDK)
108110
- [`workload update`](dotnet-workload-update.md) (Available since .NET 6 SDK)
109111
- [`workload restore`](dotnet-workload-restore.md) (Available since .NET 6 SDK)

‎docs/navigate/tools-diagnostics/toc.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,8 @@ items:
190190
href: ../../core/tools/dotnet-package-remove.md
191191
- name: dotnet package search
192192
href: ../../core/tools/dotnet-package-search.md
193+
- name: dotnet package update
194+
href: ../../core/tools/dotnet-package-update.md
193195
- name: dotnet publish
194196
href: ../../core/tools/dotnet-publish.md
195197
- name: dotnet reference add/list/remove
@@ -239,8 +241,12 @@ items:
239241
href: ../../core/tools/dotnet-workload.md
240242
- name: dotnet workload sets
241243
href: ../../core/tools/dotnet-workload-sets.md
244+
- name: dotnet workload clean
245+
href: ../../core/tools/dotnet-workload-clean.md
242246
- name: dotnet workload config
243247
href: ../../core/tools/dotnet-workload-config.md
248+
- name: dotnet workload history
249+
href: ../../core/tools/dotnet-workload-history.md
244250
- name: dotnet workload install
245251
href: ../../core/tools/dotnet-workload-install.md
246252
- name: dotnet workload list

0 commit comments

Comments
 (0)