Skip to content

Commit 13f4e99

Browse files
authored
Update name to match branding (#4690)
1 parent 894af62 commit 13f4e99

File tree

1 file changed

+36
-36
lines changed

1 file changed

+36
-36
lines changed

hub/package-manager/winget/index.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
---
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: 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
55
ms.topic: overview
66
ms.localizationpriority: medium
77
---
88

9-
# Use the winget tool to install and manage applications
9+
# Use the WinGet tool to install and manage applications
1010

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.
1212

13-
## Install winget
13+
## Install WinGet
1414

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**.
1616

1717
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.
1818

1919
> [!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`.
2121
22-
### Install winget preview version [Developers Only]
22+
### Install WinGet preview version [Developers Only]
2323

2424
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:
2525

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.
2727

2828
- 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.
2929

3030
- 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.
3131

32-
### Install winget on Windows Sandbox
32+
### Install WinGet on Windows Sandbox
3333

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.
3535

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:
3737

3838
```powershell
3939
$progressPreference = 'silentlyContinue'
@@ -52,37 +52,37 @@ For more information on Windows Sandbox, including how to install a sandbox and
5252

5353
## Administrator considerations
5454

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.
5656

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.
5858

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.
6060

61-
## Use winget
61+
## Use WinGet
6262

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.
6464

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

6767
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.
6969
![winget commandline](./images/install.png)
7070

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`.
7272
![winget help](./images/help.png)
7373

7474
Some users have reported [issues](https://github.com/microsoft/winget-cli/issues/210) with the client not being on their PATH.
7575

7676
### Commands
7777

78-
The current preview of the **winget** tool supports the following commands.
78+
The current preview of the **WinGet** tool supports the following commands.
7979

8080
| Command | Description |
8181
|---------|-------------|
8282
| [info](info.md) | Displays metadata about the system (version numbers, architecture, log location, etc). Helpful for troubleshooting. |
8383
| [install](install.md) | Installs the specified application. |
8484
| [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. |
8686
| [search](search.md) | Searches for an application. |
8787
| [list](list.md) | Display installed packages. |
8888
| [upgrade](upgrade.md) | Upgrades the given package. |
@@ -99,17 +99,17 @@ The current preview of the **winget** tool supports the following commands.
9999

100100
### Options
101101

102-
The **winget** tool supports the following options.
102+
The **WinGet** tool supports the following options.
103103

104104
| Option | Description |
105105
|--------------|-------------|
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. |
109109

110110
## Supported installer formats
111111

112-
The **winget** tool supports the following types of installers:
112+
The **WinGet** tool supports the following types of installers:
113113

114114
* EXE (with **Silent** and **SilentWithProgress** flags)
115115
* ZIP
@@ -122,7 +122,7 @@ The **winget** tool supports the following types of installers:
122122
* BURN
123123
* PORTABLE
124124

125-
## Scripting winget
125+
## Scripting WinGet
126126

127127
You can use the following syntax to install multiple applications in a single command.
128128

@@ -135,31 +135,31 @@ winget install Microsoft.WindowsTerminal Microsoft.PowerToys Microsoft.VisualStu
135135
```
136136

137137
> [!NOTE]
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.
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.
139139
140140
## Debugging and troubleshooting
141141

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).
143143

144144
## Missing tools
145145

146146
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.
147147

148-
## Customize winget settings
148+
## Customize WinGet settings
149149

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.
151151

152152
## Open source details
153153

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).
155155

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/).
157157

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.
159159

160160
## Troubleshooting
161161

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:
163163

164164
- [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)
165165
- [common errors -- Error 0x801901a0, 0x80d03002, 0x80070490](https://github.com/microsoft/winget-cli/tree/master/doc/troubleshooting#common-errors)

0 commit comments

Comments
 (0)