Skip to content

Commit 847ea89

Browse files
Merge pull request MicrosoftDocs#5522 from MicrosoftDocs/main
Merged by Learn.Build PR Management system
2 parents a244858 + 9aed405 commit 847ea89

File tree

3 files changed

+42
-26
lines changed

3 files changed

+42
-26
lines changed

hub/package-manager/winget/configure.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,40 +15,54 @@ The **configure** command of the [winget](./index.md) tool uses a [WinGet Config
1515
1616
## Prerequisites
1717

18-
- Windows 10 RS5 or later, and Windows 11.
18+
- Windows 10 version 1809 (build 17763) or later, or Windows 11.
1919
- WinGet version [v1.6.2631 or later](https://github.com/microsoft/winget-cli/releases).
2020

2121
## Aliases
2222

2323
The following aliases are available for this command:
2424

2525
- configuration
26+
- dsc
2627

2728
## Usage
2829

2930
`winget configure -f <C:/Users/<username>/winget-configs/config-file-name.dsc.yaml>`
3031

31-
Once you have identified the winget configuration file that you are interested in using, confirmed the safety and trustworthiness of that file, and downloaded the file to your local machine, you can use the `winget configure` command to initiate the set up of your configuration.
32+
Once you have identified the winget configuration file that you are interested in using, confirmed the safety and trustworthiness of that file, and downloaded the file to your local machine, you can use the `winget configure` command to initiate the set up of your configuration.
3233

3334
## Arguments and options
3435

3536
The following arguments are available:
3637

37-
| Argument | Description |
38+
| Argument | Description |
3839
|--------------|-------------|
39-
|-f,--file | The path to the winget configuration file. |
40-
|-?, --help | Gets additional help on this command. |
41-
|--wait | Prompts the user to press any key before exiting. |
42-
|--verbose, --verbose-logs | Enables verbose logging for winget. |
43-
|--disable-interactivity | Disable interactive prompts. |
40+
| -f,--file | The path to the winget configuration file. |
41+
| --module-path | Specifies the location on the local computer to store modules. Default %LOCALAPPDATA%\Microsoft\WinGet\Configuration\Modules. |
42+
| --processor-path | Specifies the path to the configuration processor. |
43+
| -h,--history | Select items from history. |
44+
| --accept-configuration-agreements | Accepts the configuration warning, preventing an interactive prompt. |
45+
| --suppress-initial-details | Suppress showing initial configuration details when possible. |
46+
| --enable | Enable configuration components. Requires store access. |
47+
| --disable | Disable configuration components. Requires store access. |
48+
| -?,--help | Shows help about the selected command. |
49+
| --wait | Prompts the user to press any key before exiting. |
50+
| --logs,--open-logs | Open the default logs location. |
51+
| --verbose,--verbose-logs | Enables verbose logging for winget. |
52+
| --nowarn,--ignore-warnings | Suppresses warning outputs. |
53+
| --disable-interactivity | Disable interactive prompts. |
54+
| --proxy | Set a proxy to use for this execution. |
55+
| --no-proxy | Disable the use of proxy for this execution. |
4456

4557
## configure subcommands
4658

4759
The `winget configure` command includes a number of subcommands, including:
4860

49-
- **`winget configure show`**: Displays the details of a configuration file. Usage: `winget configure show -f <C:/Users/<username>/winget-configs/config-file-name.dsc.yaml>`. Running the command: `winget configuration show configuration.dsc.yaml` will display the details of the configuration in the current working directory.
50-
- `winget configure test`: Checks the system against the desired state, displaying whether the current system state conforms with the desired state defined in the associated configuration file. Usage: `winget configure test -f <C:/Users/<username>/winget-configs/config-file-name.dsc.yaml>`.
61+
- **`winget configure show`**: Displays the details of a configuration file. Usage: `winget configure show -f <file>`. Running the command: `winget configuration show configuration.dsc.yaml` will display the details of the configuration in the current working directory.
62+
- `winget configure list`: Shows the high level details for configurations that have been applied to the system. This data can then be used with other `configure` commands to get more details. Usage: `winget configure list [<options>]`
63+
- `winget configure test`: Checks the system against the desired state, displaying whether the current system state conforms with the desired state defined in the associated configuration file. Usage: `winget configure test -f <file>`.
5164
- `winget configure validate`: Validates a configuration file. Usage: `winget configure validate [-f] <file> [<options>]`.
65+
- `winget configure export`: Exports configuration resources to a configuration file. When used with `--all`, exports all package configurations. When used with `--packageId`, exports a WinGetPackage resource of the given package identifier. When used with `--module` and `--resource`, exports the settings of the specified resource. If the output configuration file already exists, appends the exported configuration resources. Usage: `winget configure export -o <output file> [<options>]`
5266

5367
## Related topics
5468

hub/package-manager/winget/index.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,21 @@ ms.localizationpriority: medium
1515
**WinGet** the Windows Package Manager is available on Windows 11, modern versions of Windows 10, and Windows Server 2025 as a part of the **App Installer**. The **App Installer** is a System Component delivered and updated by the Microsoft store on Windows Desktop versions, and via Updates on Windows Server 2025.
1616

1717
> [!NOTE]
18-
> The **WinGet** command line tool is only supported on Windows 10 1709 (build 16299) or later at this time. WinGet will not be available until you have logged into Windows as a user for the first time, triggering Microsoft Store to register the Windows Package Manager as part of an asynchronous process. If you have recently logged in as a user for the first time and find that WinGet is not yet available, you can open PowerShell and enter the following command to request this WinGet registration: `Add-AppxPackage -RegisterByFamilyName -MainPackage Microsoft.DesktopAppInstaller_8wekyb3d8bbwe`.
18+
> The **WinGet** command line tool is only supported on Windows 10 version 1809 (build 17763) or later. WinGet will not be available until you have logged into Windows as a user for the first time, triggering Microsoft Store to register the Windows Package Manager as part of an asynchronous process. If you have recently logged in as a user for the first time and find that WinGet is not yet available, you can open PowerShell and enter the following command to request this WinGet registration: `Add-AppxPackage -RegisterByFamilyName -MainPackage Microsoft.DesktopAppInstaller_8wekyb3d8bbwe`.
1919
2020
### Install WinGet preview version [Developers Only]
2121

22-
WinGet is included in the Windows App Installer. To try the latest Windows Package Manager features, you can install a preview build one of the following ways:
22+
WinGet is included in the App Installer. To try the latest Windows Package Manager features, you can install a preview build one of the following ways:
2323

2424
- Download the latest [WinGet preview version](https://aka.ms/getwingetpreview). Read the [Release notes for WinGet preview](https://github.com/microsoft/winget-cli/releases) to learn about any new features. Installing this package will give you the preview version of the WinGet client, but it will not enable automatic updates of new preview versions from the Microsoft Store.
2525

26-
- Use a Microsoft Account (MSA), work, school or Azure Active Directory (AAD) account to sign up for the [Windows Insider Dev Channel](https://insider.windows.com/understand-flighting). The Windows Insider Dev Channel includes automatic updates of new preview versions from the Microsoft Store.
26+
- Use a Microsoft Account (MSA), work, school or Azure Active Directory (AAD) account to sign up for the [Windows Insider Program](https://www.microsoft.com/windowsinsider/about-windows-insider-program) in the Canary or Dev [Channels](https://learn.microsoft.com/windows-insider/flighting). The Windows Insider Canary and Dev Channels include automatic updates of new preview versions of WinGet from the Microsoft Store.
2727

2828
- Use a Microsoft Account (MSA) to sign up for the [Windows Package Manager Insiders Program](https://aka.ms/AppInstaller_InsiderProgram). Once your Microsoft Account (MSA) has been added (a few days after you receive e-mail notification) you will receive automatic updates of new preview versions from the Microsoft Store.
2929

3030
### Install WinGet on Windows Sandbox
3131

32-
[Windows Sandbox](/windows/security/threat-protection/windows-sandbox/windows-sandbox-overview) provides a lightweight desktop environment to safely run applications in isolation. Software installed inside the Windows Sandbox environment remains "sandboxed" and runs separately from the host machine. Windows Sandbox does not include WinGet, nor the Microsoft Store app, so you will need to download the latest WinGet package from the WinGet releases page on GitHub.
32+
[Windows Sandbox](/windows/security/threat-protection/windows-sandbox/windows-sandbox-overview) provides a lightweight desktop environment to safely run applications in isolation. Software installed inside the Windows Sandbox environment remains "sandboxed" and runs separately from the host machine. Windows Sandbox does not include WinGet, nor the Microsoft Store app, so you will need to download the latest WinGet package from the WinGet releases page on GitHub, or use the Repair-WinGetPackageManager cmdlet.
3333

3434
To install the stable release of WinGet on Windows Sandbox, follow these steps from a Windows PowerShell command prompt:
3535

@@ -43,21 +43,21 @@ Repair-WinGetPackageManager -AllUsers
4343
Write-Host "Done."
4444
```
4545

46-
To install the PowerShell module in machine scope, you can use the `-Scope AllUsers` parameter with the `Install-Module` cmdlet. If you would like a preview version of WinGet, you can add `-IncludePrerelease` parameter with the Repair-WinGetPackageManager cmdlet. To see the available parameters for the Repair-WinGetPackageManager cmdlet, you can run `Get-Help Repair-WinGetPackageManager -Full`.
46+
To install the WinGet PowerShell module in machine scope, you can use the `-Scope AllUsers` parameter with the `Install-Module` cmdlet. If you would like a preview version of WinGet, you can add `-IncludePrerelease` parameter with the Repair-WinGetPackageManager cmdlet. To see the available parameters for the Repair-WinGetPackageManager cmdlet, you can run `Get-Help Repair-WinGetPackageManager -Full`.
4747

4848
For more information on Windows Sandbox, including how to install a sandbox and what to expect from it's usage, see the [Windows Sandbox docs](/windows/security/threat-protection/windows-sandbox/windows-sandbox-overview).
4949

5050
## Administrator considerations
5151

5252
Installer behavior can be different depending on whether you are running **WinGet** with administrator privileges.
5353

54-
* When running **WinGet** without administrator privileges, some applications may [require elevation](/windows/security/identity-protection/user-account-control/how-user-account-control-works) to install. When the installer runs, Windows will prompt you to [elevate](/windows/security/identity-protection/user-account-control/how-user-account-control-works). If you choose not to elevate, the application will fail to install.
54+
* When running **WinGet** without administrator privileges, some applications may [require elevation](/windows/security/identity-protection/user-account-control/how-user-account-control-works) to install. When the installer runs, Windows will prompt you to [elevate](/windows/security/identity-protection/user-account-control/how-user-account-control-works). If you choose not to elevate, the application will fail to install.
5555

5656
* When running **WinGet** in an Administrator Command Prompt, you will not see [elevation prompts](/windows/security/identity-protection/user-account-control/how-user-account-control-works) if the application requires it. Always use caution when running your command prompt as an administrator, and only install applications you trust.
5757

5858
## Use WinGet
5959

60-
After **App Installer** is installed, you can run **WinGet** by typing 'WinGet' from a Command Prompt.
60+
After **App Installer** is installed, you can run **WinGet** by typing 'winget' from a Command Prompt.
6161

6262
One of the most common usage scenarios is to search for and install a favorite tool.
6363

@@ -76,14 +76,14 @@ The current preview of the **WinGet** tool supports the following commands.
7676

7777
| Command | Description |
7878
|---------|-------------|
79-
| [info](info.md) | Displays metadata about the system (version numbers, architecture, log location, etc). Helpful for troubleshooting. |
79+
| [--info](info.md) | Displays metadata about the system (version numbers, architecture, log location, etc). Helpful for troubleshooting. |
8080
| [install](install.md) | Installs the specified application. |
8181
| [show](show.md) | Displays details for the specified application. |
8282
| [source](source.md) | Adds, removes, and updates the Windows Package Manager repositories accessed by the **WinGet** tool. |
8383
| [search](search.md) | Searches for an application. |
8484
| [list](list.md) | Display installed packages. |
85-
| [upgrade](upgrade.md) | Upgrades the given package. |
86-
| [uninstall](uninstall.md) | Uninstalls the given package. |
85+
| [upgrade](upgrade.md) | Upgrades the given specified application. |
86+
| [uninstall](uninstall.md) | Uninstalls the specified application. |
8787
| [hash](hash.md) | Generates the SHA256 hash for the installer. |
8888
| [validate](validate.md) | Validates a manifest file for submission to the Windows Package Manager repository. |
8989
| [settings](settings.md) | Open settings. |
@@ -132,7 +132,7 @@ winget install Microsoft.WindowsTerminal Microsoft.PowerToys Microsoft.VisualStu
132132
```
133133

134134
> [!NOTE]
135-
> When scripted, **WinGet** will launch the applications in the specified order. When an installer returns success or failure, **WinGet** will launch the next installer. If an installer launches another process, it is possible that it will return to **WinGet** prematurely. This will cause **WinGet** to install the next installer before the previous installer has completed.
135+
> When scripted, **WinGet** will install the applications in the specified order. When an installer returns success or failure, **WinGet** will launch the next installer. If an installer launches another process, it is possible that it will return to **WinGet** prematurely. This will cause **WinGet** to install the next installer before the previous installer has completed.
136136
137137
## Debugging and troubleshooting
138138

@@ -144,7 +144,7 @@ If the [community repository](../package/repository.md) does not include your to
144144

145145
## Customize WinGet settings
146146

147-
You can configure the **WinGet** command line experience by modifying the **settings.json** file. For more information, see [https://aka.ms/winget-settings](https://aka.ms/winget-settings). Note that the settings are still in an experimental state and not yet finalized for the preview version of the tool.
147+
You can configure the **WinGet** command line experience by modifying the **settings.json** file. For more information, see the page for the [settings command](./settings.md).
148148

149149
## Open source details
150150

@@ -156,7 +156,7 @@ We encourage you to contribute to the **WinGet** source on GitHub. You must firs
156156

157157
## Troubleshooting
158158

159-
The WinGet-cli repo maintains a list of common issues and common errors, along with recommendations on how to resolve:
159+
The winget-cli repo maintains a list of common issues and common errors, along with recommendations on how to resolve:
160160

161161
- [common issues -- not recognized, failed to run, App Installer version or PATH variable need updating](https://github.com/microsoft/winget-cli/tree/master/doc/troubleshooting#common-issues)
162162
- [common errors -- Error 0x801901a0, 0x80d03002, 0x80070490](https://github.com/microsoft/winget-cli/tree/master/doc/troubleshooting#common-errors)

landing/arm-docs/arm64x-build.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,14 +85,16 @@ To build your CMake project binaries as Arm64X, you can use any version of [CMak
8585
"inherits": "arm64-debug",
8686
"cacheVariables": {
8787
"BUILD_AS_ARM64X": "ARM64"
88-
},
89-
{
88+
}
89+
},
90+
{
9091
"name": "arm64ec-debug-x",
9192
"displayName": "arm64ec Debug (arm64x)",
9293
"inherits": "arm64ec-debug",
9394
"cacheVariables": {
9495
"BUILD_AS_ARM64X": "ARM64EC"
95-
}
96+
}
97+
}
9698
```
9799

98100
3. Add a new .cmake file to your CMake project called `arm64x.cmake`. Copy the snippet below into the new .cmake file.

0 commit comments

Comments
 (0)