Skip to content

Commit 307439a

Browse files
committed
Improve readability of workload IDs and switches
Since different commands use different switch prefixes, make that clear in the readme.
1 parent d3b416a commit 307439a

File tree

1 file changed

+24
-23
lines changed

1 file changed

+24
-23
lines changed

readme.md

+24-23
Original file line numberDiff line numberDiff line change
@@ -297,29 +297,30 @@ Examples:
297297
For commands that receive workload ID switches (i.e. `vs where -requires [WORKLOAD_ID]` or
298298
`vs install --add [WORKLOAD_ID]`), the following aliases are available:
299299

300-
| Switch | Workload ID |
301-
|-------------|----------------------------|
302-
| `--mobile` | Microsoft.VisualStudio.Workload.NetCrossPlat |
303-
| `--core` | Microsoft.VisualStudio.Workload.NetCoreTools |
304-
| `--azure` | Microsoft.VisualStudio.Workload.Azure |
305-
| `--data` | Microsoft.VisualStudio.Workload.Data |
306-
| `--desktop` | Microsoft.VisualStudio.Workload.ManagedDesktop |
307-
| `--unity` | Microsoft.VisualStudio.Workload.ManagedGame |
308-
| `--native` | Microsoft.VisualStudio.Workload.NativeDesktop |
309-
| `--xamarin` | Microsoft.VisualStudio.Workload.NetCrossPlat |
310-
| `--web` | Microsoft.VisualStudio.Workload.NetWeb |
311-
| `--node` | Microsoft.VisualStudio.Workload.Node |
312-
| `--office` | Microsoft.VisualStudio.Workload.Office |
313-
| `--py` | Microsoft.VisualStudio.Workload.Python |
314-
| `--python` | Microsoft.VisualStudio.Workload.Python |
315-
| `--uwp` | Microsoft.VisualStudio.Workload.Universal |
316-
| `--vsx` | Microsoft.VisualStudio.Workload.VisualStudioExtension |
317-
318-
The switches are converted to the appropriate argument automatically, such as into
319-
`-requires [ID]` or `--add [ID]`. Additionally, the switches can also be specified
320-
with a `+` (like `+mobile`), which might make for a more intuitive command line,
321-
such as `vs install +mobile -sku:enterprise` or `vs +mobile` (runs the VS with the
322-
mobile workload installed).
300+
| Alias | Workload ID |
301+
|-----------|----------------------------|
302+
| `mobile` | Microsoft.VisualStudio.Workload.NetCrossPlat |
303+
| `core` | Microsoft.VisualStudio.Workload.NetCoreTools |
304+
| `azure` | Microsoft.VisualStudio.Workload.Azure |
305+
| `data` | Microsoft.VisualStudio.Workload.Data |
306+
| `desktop` | Microsoft.VisualStudio.Workload.ManagedDesktop |
307+
| `unity` | Microsoft.VisualStudio.Workload.ManagedGame |
308+
| `native` | Microsoft.VisualStudio.Workload.NativeDesktop |
309+
| `xamarin` | Microsoft.VisualStudio.Workload.NetCrossPlat |
310+
| `web` | Microsoft.VisualStudio.Workload.NetWeb |
311+
| `node` | Microsoft.VisualStudio.Workload.Node |
312+
| `office` | Microsoft.VisualStudio.Workload.Office |
313+
| `py` | Microsoft.VisualStudio.Workload.Python |
314+
| `python` | Microsoft.VisualStudio.Workload.Python |
315+
| `uwp` | Microsoft.VisualStudio.Workload.Universal |
316+
| `vsx` | Microsoft.VisualStudio.Workload.VisualStudioExtension |
317+
318+
The aliases are converted to the appropriate switch automatically, such as into
319+
`-requires [ID]` or `--add [ID]`. Additionally, depending on the command being run,
320+
the aliases might use a `+` prefix (like `+mobile`), which might make for a more
321+
intuitive command line, such as `vs install +mobile -sku:enterprise` or `vs +mobile`
322+
(runs the VS with the mobile workload installed). The *modify* command uses `+` and `-`
323+
prefix to add or remove workloads respectively, for example.
323324

324325

325326
## Sponsors

0 commit comments

Comments
 (0)