You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
32
33
33
34
## Arguments and options
34
35
35
36
The following arguments are available:
36
37
37
-
| Argument | Description |
38
+
| Argument | Description |
38
39
|--------------|-------------|
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. |
| --proxy | Set a proxy to use for this execution. |
55
+
| --no-proxy | Disable the use of proxy for this execution. |
44
56
45
57
## configure subcommands
46
58
47
59
The `winget configure` command includes a number of subcommands, including:
48
60
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>`.
-`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>]`
Copy file name to clipboardExpand all lines: hub/package-manager/winget/index.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,21 +15,21 @@ ms.localizationpriority: medium
15
15
**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.
16
16
17
17
> [!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`.
19
19
20
20
### Install WinGet preview version [Developers Only]
21
21
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:
23
23
24
24
- 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.
25
25
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.
27
27
28
28
- 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.
29
29
30
30
### Install WinGet on Windows Sandbox
31
31
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.
33
33
34
34
To install the stable release of WinGet on Windows Sandbox, follow these steps from a Windows PowerShell command prompt:
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`.
47
47
48
48
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).
49
49
50
50
## Administrator considerations
51
51
52
52
Installer behavior can be different depending on whether you are running **WinGet** with administrator privileges.
53
53
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.
55
55
56
56
* 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.
57
57
58
58
## Use WinGet
59
59
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.
61
61
62
62
One of the most common usage scenarios is to search for and install a favorite tool.
63
63
@@ -76,14 +76,14 @@ The current preview of the **WinGet** tool supports the following commands.
76
76
77
77
| Command | Description |
78
78
|---------|-------------|
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. |
80
80
|[install](install.md)| Installs the specified application. |
81
81
|[show](show.md)| Displays details for the specified application. |
82
82
|[source](source.md)| Adds, removes, and updates the Windows Package Manager repositories accessed by the **WinGet** tool. |
83
83
|[search](search.md)| Searches for an application. |
84
84
|[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. |
87
87
|[hash](hash.md)| Generates the SHA256 hash for the installer. |
88
88
|[validate](validate.md)| Validates a manifest file for submission to the Windows Package Manager repository. |
> 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.
136
136
137
137
## Debugging and troubleshooting
138
138
@@ -144,7 +144,7 @@ If the [community repository](../package/repository.md) does not include your to
144
144
145
145
## Customize WinGet settings
146
146
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).
148
148
149
149
## Open source details
150
150
@@ -156,7 +156,7 @@ We encourage you to contribute to the **WinGet** source on GitHub. You must firs
156
156
157
157
## Troubleshooting
158
158
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:
160
160
161
161
-[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)
0 commit comments