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
title: Use the winget tool to install and manage applications
3
-
description: The winget command line tool enables developers to discover, install, upgrade, remove and configure applications on Windows computers.
4
-
ms.date: 02/10/2023
2
+
title: Use the WinGet tool to install and manage applications
3
+
description: The WinGet command line tool enables developers to discover, install, upgrade, remove and configure applications on Windows computers.
4
+
ms.date: 08/05/2024
5
5
ms.topic: overview
6
6
ms.localizationpriority: medium
7
7
---
8
8
9
-
# Use the winget tool to install and manage applications
9
+
# Use the WinGet tool to install and manage applications
10
10
11
-
The **winget** command line tool enables users to discover, install, upgrade, remove and configure applications on Windows 10 and Windows 11 computers. This tool is the client interface to the Windows Package Manager service.
11
+
The **WinGet** command line tool enables users to discover, install, upgrade, remove and configure applications on Windows 10 and Windows 11 computers. This tool is the client interface to the Windows Package Manager service.
12
12
13
-
## Install winget
13
+
## Install WinGet
14
14
15
-
Windows Package Manager **winget** command-line tool is available on Windows 11 and modern versions of Windows 10 as a part of the **App Installer**.
15
+
Windows Package Manager **WinGet** command-line tool is available on Windows 11 and modern versions of Windows 10 as a part of the **App Installer**.
16
16
17
17
You can [get App Installer from the Microsoft Store](https://www.microsoft.com/p/app-installer/9nblggh4nns1#activetab=pivot:overviewtab). If it's already installed, make sure it is updated with the latest version.
18
18
19
19
> [!NOTE]
20
-
> The **winget** command line tool is only supported on Windows 10 1709 (build 16299) or later at this time. The winget tool will not be available until you have logged into Windows as a user for the first time, triggering Microsoft Store to register 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`.
20
+
> The **WinGet** command line tool is only supported on Windows 10 1709 (build 16299) or later at this time. The WinGet tool will not be available until you have logged into Windows as a user for the first time, triggering Microsoft Store to register 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`.
21
21
22
-
### Install winget preview version [Developers Only]
22
+
### Install WinGet preview version [Developers Only]
23
23
24
24
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:
25
25
26
-
- 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.
26
+
- 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.
27
27
28
28
- 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.
29
29
30
30
- 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.
31
31
32
-
### Install winget on Windows Sandbox
32
+
### Install WinGet on Windows Sandbox
33
33
34
-
[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.
34
+
[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.
35
35
36
-
To install the stable release of winget on Windows Sandbox, follow these steps from a Windows PowerShell command prompt:
36
+
To install the stable release of WinGet on Windows Sandbox, follow these steps from a Windows PowerShell command prompt:
37
37
38
38
```powershell
39
39
$progressPreference = 'silentlyContinue'
@@ -52,37 +52,37 @@ For more information on Windows Sandbox, including how to install a sandbox and
52
52
53
53
## Administrator considerations
54
54
55
-
Installer behavior can be different depending on whether you are running **winget** with administrator privileges.
55
+
Installer behavior can be different depending on whether you are running **WinGet** with administrator privileges.
56
56
57
-
* 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.
57
+
* 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.
58
58
59
-
* 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.
59
+
* 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.
60
60
61
-
## Use winget
61
+
## Use WinGet
62
62
63
-
After **App Installer** is installed, you can run **winget** by typing 'winget' from a Command Prompt.
63
+
After **App Installer** is installed, you can run **WinGet** by typing 'WinGet' from a Command Prompt.
64
64
65
65
One of the most common usage scenarios is to search for and install a favorite tool.
66
66
67
67
1. To [search](./search.md) for a tool, type `winget search <appname>`.
68
-
2. After you have confirmed that the tool you want is available, you can [install](./install.md) the tool by typing `winget install <appname>`. The **winget** tool will launch the installer and install the application on your PC.
68
+
2. After you have confirmed that the tool you want is available, you can [install](./install.md) the tool by typing `winget install <appname>`. The **WinGet** tool will launch the installer and install the application on your PC.
69
69

70
70
71
-
3. In addition to install and search, **winget** provides a number of other commands that enable you to [show details](show.md) on applications, [change sources](./source.md), and [validate packages](./validate.md). To get a complete list of commands, type: `winget --help`.
71
+
3. In addition to install and search, **WinGet** provides a number of other commands that enable you to [show details](show.md) on applications, [change sources](./source.md), and [validate packages](./validate.md). To get a complete list of commands, type: `winget --help`.
72
72

73
73
74
74
Some users have reported [issues](https://github.com/microsoft/winget-cli/issues/210) with the client not being on their PATH.
75
75
76
76
### Commands
77
77
78
-
The current preview of the **winget** tool supports the following commands.
78
+
The current preview of the **WinGet** tool supports the following commands.
79
79
80
80
| Command | Description |
81
81
|---------|-------------|
82
82
|[info](info.md)| Displays metadata about the system (version numbers, architecture, log location, etc). Helpful for troubleshooting. |
83
83
|[install](install.md)| Installs the specified application. |
84
84
|[show](show.md)| Displays details for the specified application. |
85
-
|[source](source.md)| Adds, removes, and updates the Windows Package Manager repositories accessed by the **winget** tool. |
85
+
|[source](source.md)| Adds, removes, and updates the Windows Package Manager repositories accessed by the **WinGet** tool. |
86
86
|[search](search.md)| Searches for an application. |
87
87
|[list](list.md)| Display installed packages. |
88
88
|[upgrade](upgrade.md)| Upgrades the given package. |
@@ -99,17 +99,17 @@ The current preview of the **winget** tool supports the following commands.
99
99
100
100
### Options
101
101
102
-
The **winget** tool supports the following options.
102
+
The **WinGet** tool supports the following options.
103
103
104
104
| Option | Description |
105
105
|--------------|-------------|
106
-
|**-v, --version**| Returns the current version of winget. |
107
-
|**--info**| Provides you with all detailed information on winget, including the links to the license, privacy statement, and configured group policies. |
108
-
|**-?, --help**| Shows additional help for winget. |
106
+
|**-v, --version**| Returns the current version of WinGet. |
107
+
|**--info**| Provides you with all detailed information on WinGet, including the links to the license, privacy statement, and configured group policies. |
108
+
|**-?, --help**| Shows additional help for WinGet. |
109
109
110
110
## Supported installer formats
111
111
112
-
The **winget** tool supports the following types of installers:
112
+
The **WinGet** tool supports the following types of installers:
113
113
114
114
* EXE (with **Silent** and **SilentWithProgress** flags)
115
115
* ZIP
@@ -122,7 +122,7 @@ The **winget** tool supports the following types of installers:
122
122
* BURN
123
123
* PORTABLE
124
124
125
-
## Scripting winget
125
+
## Scripting WinGet
126
126
127
127
You can use the following syntax to install multiple applications in a single command.
> 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.
138
+
> 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.
139
139
140
140
## Debugging and troubleshooting
141
141
142
-
**winget** provides logging to help diagnose issues. For troubleshooting and details on logging, see [Debugging and troubleshooting](./troubleshooting.md).
142
+
**WinGet** provides logging to help diagnose issues. For troubleshooting and details on logging, see [Debugging and troubleshooting](./troubleshooting.md).
143
143
144
144
## Missing tools
145
145
146
146
If the [community repository](../package/repository.md) does not include your tool or application, please submit a package to our [repository](https://github.com/microsoft/winget-pkgs). By adding your favorite tool, it will be available to you and everyone else.
147
147
148
-
## Customize winget settings
148
+
## Customize WinGet settings
149
149
150
-
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.
150
+
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.
151
151
152
152
## Open source details
153
153
154
-
The **winget** tool is open source software available on GitHub in the repo [https://github.com/microsoft/winget-cli/](https://github.com/microsoft/winget-cli/). The source for building the client is located in the [src folder](https://github.com/microsoft/winget-cli/tree/master/src).
154
+
The **WinGet** tool is open source software available on GitHub in the repo [https://github.com/microsoft/winget-cli/](https://github.com/microsoft/winget-cli/). The source for building the client is located in the [src folder](https://github.com/microsoft/winget-cli/tree/master/src).
155
155
156
-
The source for **winget** is contained in a Visual Studio 2019 C++ solution. To build the solution correctly, install the latest [Visual Studio with the C++ workload](https://visualstudio.microsoft.com/downloads/).
156
+
The source for **WinGet** is contained in a Visual Studio 2019 C++ solution. To build the solution correctly, install the latest [Visual Studio with the C++ workload](https://visualstudio.microsoft.com/downloads/).
157
157
158
-
We encourage you to contribute to the **winget** source on GitHub. You must first agree to and sign the Microsoft CLA.
158
+
We encourage you to contribute to the **WinGet** source on GitHub. You must first agree to and sign the Microsoft CLA.
159
159
160
160
## Troubleshooting
161
161
162
-
The winget-cli repo maintains a list of common issues and common errors, along with recommendations on how to resolve:
162
+
The WinGet-cli repo maintains a list of common issues and common errors, along with recommendations on how to resolve:
163
163
164
164
-[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