winget-cli

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

README.md (8857B)

      1 # ![WinGet Icon](.github/images/WindowsPackageManager_Assets/ICO/PNG/_40.png) Windows Package Manager
      2 
      3 ## WinGet Client
      4 
      5 ![winget install wingetcreate](.github/images/WingetInstall.gif)
      6 
      7 If you are new to the Windows Package Manager, you might want to [Explore the Windows Package Manager tool](https://docs.microsoft.com/learn/modules/explore-windows-package-manager-tool/?WT.mc_id=AZ-MVP-5004737). The client has access to packages from two default sources. The first is "msstore" the Microsoft Store (free Apps rated "e" for everyone). The second is "winget" the [WinGet community repository](https://github.com/microsoft/winget-pkgs).
      8 
      9 > [!NOTE]
     10 > Group policy may be configured and modify configured sources. Run `winget --info` to see any configured policies.
     11 
     12 ## Installing The Client
     13 
     14 > [!NOTE]
     15 > The client requires Windows 10 1809 (build 17763) or later at this time. Windows Server 2019 is not supported as the Microsoft Store is not available nor are updated dependencies. It may be possible to install on Windows Server 2022, this should be considered experimental (not supported) and requires dependencies to be manually installed as well.
     16 
     17 ### Microsoft Store [Recommended]
     18 
     19 The client is distributed within the [App Installer](https://apps.microsoft.com/detail/9nblggh4nns1) package.
     20 
     21 ### Development Releases
     22 
     23 There are two methods to get development releases:
     24 
     25 * Install a [Windows 10 or Windows 11 Insider](https://insider.windows.com/) build.
     26 * Join the Windows Package Manager Insider program by [signing up](http://aka.ms/winget-InsiderProgram).
     27 
     28 > [!NOTE]
     29 > It may take a few days to get the updated App Installer after you receive e-mail confirmation from joining the Windows Package Manager Insider program. If you decide to install the latest release from GitHub, and you have successfully joined the insider program, you will receive updates when the next development release has been published in the Microsoft Store.
     30 
     31 Once you have received the updated App Installer from the Microsoft Store you should be able to execute `winget features` to see experimental features. Some users have reported [issues](https://github.com/microsoft/winget-cli/issues/210) with the client not being on their PATH.
     32 
     33 ### Manually Update
     34 
     35 The same Microsoft Store package will be made available via our [Releases](https://github.com/microsoft/winget-cli/releases). Note that installing this package will give you the WinGet client, but it will not enable automatic updates from the Microsoft Store if you have not joined the Windows Package Manager Insider program.
     36 
     37 > [!NOTE]
     38 > You may need to install the [VC++ v14 Desktop Framework Package](https://docs.microsoft.com/troubleshoot/cpp/c-runtime-packages-desktop-bridge#how-to-install-and-update-desktop-framework-packages).
     39 > This should only be necessary on older builds of Windows 10 and only if you get an error about missing framework packages.
     40 
     41 ### Troubleshooting
     42 
     43 Please read our [troubleshooting guide](/doc/troubleshooting/README.md).
     44 
     45 ## Administrator Considerations
     46 
     47 Installer behavior can be different depending on whether you are running **WinGet** with administrator privileges.
     48 
     49 * When running **WinGet** without administrator privileges, some applications may [require elevation](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works) to install. When the installer runs, Windows will prompt you to [elevate](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works#the-uac-user-experience). If you choose not to elevate, the application will fail to install.
     50 
     51 * When running **WinGet** in an Administrator Command Prompt, you will not see [elevation prompts](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works#the-uac-user-experience) if the application requires it. Always use caution when running your command prompt as an administrator, and only install applications you trust.
     52 
     53 ### Build your own
     54 
     55 You can also [build the client yourself](#building-the-client). While the client should be perfectly functional, we are not ready to provide full support for clients running outside of the official distribution mechanisms yet. Feel free to file an [Issue](https://github.com/microsoft/winget-cli/issues/new/choose), but know that it may get lower prioritization.
     56 
     57 ## Build Status
     58 
     59 [![Build Status](https://dev.azure.com/shine-oss/winget-cli/_apis/build/status/winget-cli%20Build_Test?branchName=master&label=Main%20Branch%20(Including%20PRs))](https://dev.azure.com/shine-oss/winget-cli/_build/latest?definitionId=10&branchName=master)
     60 
     61 ## Windows Package Manager Release Roadmap
     62 
     63 The plan for delivering the next Windows Package Manager release is described and included in our [discussions](https://github.com/microsoft/winget-cli/discussions/2063), and will be updated as the project proceeds.
     64 
     65 ## Overview of the  Windows Package Manager
     66 
     67 The **Windows Package Manager** is a tool designed to help you quickly and easily discover and install those packages that make your PC environment special.  By using the **Windows Package Manager**, from one command, you can install your favorite packages:
     68 
     69 `winget install <package>`
     70 
     71 ## Overview
     72 
     73 ### Client Repository
     74 
     75 This winget-cli repository includes the source code designed to build the client.  You are encouraged to participate in the development of this client. We have plenty of backlog features in our [Issues](https://github.com/microsoft/winget-cli/issues?q=is%3Aopen+is%3Aissue+milestone%3ABacklog-Client). You can upvote the ones you want, add more, or even [get started on one.](https://github.com/orgs/microsoft/projects/137)
     76 
     77 ### Sources
     78 
     79 The client is built around the concept of sources; a set of packages effectively. Sources provide the ability to discover and retrieve the metadata about the packages so that the client can act on it.
     80 
     81 * The default "winget" source includes packages in the [Windows Package Manager Community Repository](https://github.com/microsoft/winget-pkgs).
     82 * The default "msstore" source includes packages in the Microsoft Store.
     83 * It is also possible to host your own private [REST-based](https://github.com/microsoft/winget-cli-restsource) source.
     84 
     85 ## Building the client
     86 
     87 Please follow our [developer guidance](/doc/Developing.md) to build, run & test the client.
     88 
     89 ## Credit
     90 
     91 We would like to thank [Keivan Beigi (@kayone)](https://github.com/kayone) for his work on AppGet which helped us with the initial project direction for Windows Package Manager.
     92 
     93 ## Contributing
     94 
     95 This project welcomes contributions and suggestions.  Most contributions require you to agree to a
     96 Contributor License Agreement (CLA) declaring that you have the right to, and do, actually grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. More
     97 information is available in our [CONTRIBUTING.md](/CONTRIBUTING.md) file.
     98 
     99 When you submit a pull request, a CLA bot will automatically determine whether you need to provide
    100 a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
    101 provided by the bot. You will only need to do this once across all repos using our CLA.
    102 
    103 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
    104 For more information, please refer to the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
    105 contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
    106 
    107 ## Data/Telemetry
    108 
    109 The winget.exe client is instrumented to collect usage and diagnostic (error) data and sends it to Microsoft to help improve the product.
    110 
    111 If you build the client yourself the instrumentation will not be enabled and no data will be sent to Microsoft.
    112 
    113 The winget.exe client respects machine-wide privacy settings and users can opt out on their device, as documented in the [Microsoft Windows privacy statement](https://support.microsoft.com/help/4468236/diagnostics-feedback-and-privacy-in-windows-10-microsoft-privacy). In addition, you may also explicitly block telemetry using [settings](https://docs.microsoft.com/windows/package-manager/winget/settings)
    114 
    115 In short, to opt out, do one of the following:
    116 
    117 **Windows 11**: Go to `Start`, then select `Settings` > `Privacy & Security` > `Diagnostics & feedback` > `Diagnostic data` and unselect `Send optional diagnostic data`.
    118 
    119 **Windows 10**: Go to `Start`, then select `Settings` > `Privacy` > `Diagnostics & feedback`, and select `Required diagnostic data`.
    120 
    121 See the [privacy statement](PRIVACY.md) for more details.