Tell us about your PDF experience. Set up your development environment on Windows Article + 11/29/2022 + 3 minutes to read Windows invites you to code as you are. Use whatever coding language or framework you prefer - whether developing with tools on Windows or with Linux tools on the Windows Subsystem for Linux, this guide will help you get set up and install what you need to start coding, debugging, and accessing services to put your work into production. Development paths Get started with JavaScript Get started with JavaScript by setting up your development environment on Windows or Windows Subsystem for Linux and install Node js, React, Vue, Express, Gatsby, Nextjs, or Nuxt,js. Get started with Python Install Python and get your development environment setup on Windows or Windows Subsystem for Linux.Ga im! Get started with Android Install Android Studio, or choose a cross-platform solution like Xamarin, React, or Cordova, and get your development environment setup on Windows. Get started with Windows Desktop Get started building desktop apps for Windows using the Windows App SDK, UWP, Win32, WPF, Windows Forms, or updating and deploying existing desktop apps with MSIX and XAML Islands. Get started with C++ and C Get started with C++, C, and assembly to develop apps, services, and tools.Get started with C# Get started building apps using C# and .NET Core. Get started with F# Get started building apps using F# and .NET Core. Get started with Rust Get started programming with Rust—including how to set up Rust for Windows by consuming the windows crate.Get started with PowerShell Get started with cross-platform task automation and configuration management using PowerShell, a command-line shell and scripting language. docker Get started with Docker Desktop for Windows Create remote development containers with support from Visual Studio, VS Code, .NET, Windows Subsystem for Linux, or a variety of Azure services Get started with Blazor Get started with Blazor, a client-side UI framework within ASP.NET Core. Use HTML, CSS, and C# (rather than JavaScript) to create UI components and single page applications for the web. Tools and platformsUse your fav dual-boot). Linux distribution fully integrated with Windows (no more need for Customize your terminal environment to work with multiple command line shells.Use the winget.exe client, a comprehensive package manager, with your command line to install applications on Windows. Tune and streamline your Windows experience for greater productivity with this set of power user utilities.Visual Studio Code VS Code A lightweight source code editor with built-in support for JavaScript, TypeScript, Nodejs, a rich ecosystem of extensions (C++, C#, Java, Python, PHP, Go) and runtimes (such as NET and Unity) Install VS Code Visual Studio Visual Studio An integrated development environment that you can use to edit, debug, build code, and publish apps, including compilers, intellisense code completion, and many more features. Install Visual StudioAzure A complete cloud platform to host your existing apps and streamline new development. Azure services integrate everything you need to develop, test, deploy, and manage your apps. Set up an Azure account NET ‘An open source development platform with tools and libraries for building any type of app, including web, mobile, desktop, gaming, loT, cloud, and microservices. Install NET Run Windows and Linux Windows Subsystem for Linux (WSL) allows developers to run a Linux operating system right alongside Windows. Both share the same hard drive (and can access each other's files), the clipboard supports copy-and-paste between the two naturally, there's no needfor dual-booting. WSL enables you to use BASH and will provide the kind of environment most familiar to Mac users. Learn more in the WSL docs. https://learn microsoft.com/shows/One-Dev-Minute/What-can-|-do-with-WSL--One- Dev-Question/player?format=ny You can also use Windows Terminal to open all of your favorite command line tools in the same window with multiple tabs, or in multiple panes, whether that's PowerShell, Windows Command Prompt, Ubuntu, Debian, Azure CLI, Oh-my-Zsh, Git Bash, or all of the above. Learn more in the Windows Terminal docs. https://learn.microsoft.com/shows/One-Dev-Minute/What-are-the-main-features-of- the-new-Terminal--One-Dev-Question/player?format=ny Transitioning between Mac and Windows Check out our guide to transitioning between between a Mac and Windows (or Windows Subsystem for Linux) development environment. It can help you map the difference between Keyboard shortcuts Trackpad shortcuts Terminal and shell tools Apps and u Game development documentation © Microsoft's Game Dev documentationWindows Subsystem for Linux Documentation Article + 06/27/2022 + 2 minutes to read Windows Subsystem for Linux (WSL) lets developers run a GNU/Linux environment -- including most command-line tools, utilities, and applications -- directly on Windows, unmodified, without the overhead of a traditional virtual machine or dual-boot setup. ieee Learn more What is the Windows Subsystem for Linux (WSL)? What's new with WSL 2? Comparing WSL 1 and WSL 2 Frequently Asked Questions Get started Install WSL Install Linux on Windows Server Manual install steps Best practices for setting up a WSL development environment Try WSL preview features by joining the Windows Insiders Program To try the most recent features or updates to WSL, join the Windows Insiders Program &, Once you have joined Windows Insiders, you can choose the channel you would like to receive preview builds from inside the Windows settings menu. You can choose from: * Dev channel: Most recent updates, but low stability. * Beta channel: Ideal for early adopters, more reliable builds than the Dev channel. * Release Preview channel: Preview fixes and key features on the next version of Windows just before its available to the general public.Team blogs * Overview post with a collection of videos and blogs * Command-Line blog (Active) ‘* Windows Subsystem for Linux Blog (Historical) Provide feedback © GitHub issue tracker: WSL? © GitHub issue tracker: WSL documentation 7 Related videos WSL BASICS 1. What is the Windows Subsystem for Linux (WSL)? | One Dev Question (0:40) 2. I'm a Windows developer. Why should | use WSL? |@ One Dev Question (0:58) 3. I'm a Linux developer. Why should | use WSL? | One Dev Question (1:04) 4, What is Linux? | One Dev Question (1:31) 5. What is a Linux distro? | One Dev Question (1:04) 6. How is WSL different than a virtual machine or dual booting? ¢ | One Dev Question 7. Why was the Windows Subsystem for Linux created? | One Dev Question (1:14) 8. How do | access files on my computer in WSL? & | One Dev Question (1:41) 9. How is WSL integrated with Windows? | One Dev Question (1:34) 10. How do I configure a WSL distro to launch in the home directory in Terminal? | One Dev Question (0:47) 11. Can | use WSL for scripting? | One Dev Question (1:04) 12, Why would I want to use Linux tools on Windows? | One Dev Question (1:20) 13. In WSL, can | use distros other than the ones in the Microsoft Store? | One Dev Question (1:03) WSL DEMOS 1. WSL2: Code faster on the Windows Subsystem for Linux! | Tabs vs Spaces (13:42) 2. WSL: Run Linux GUI Apps @ | Tabs vs Spaces (17:16) 3. WSL 2: Connect USB devices « | Tabs vs Spaces (10:08) 4. GPU Accelerated Machine Learning with WSL 2. | Tabs vs Spaces (16:28) 5. Visual Studio Code: Remote Dev with SSH, VMs, and WSL®’ | Tabs vs Spaces (29:33) 6. Windows Dev Tool Updates: WSL, Terminal, Package Manager, and more | Tabs vs Spaces (20:46)7. Build NodeJS apps with WSL | Highlight (3:15) 8. New memory reclaim feature in WSL 2 | Demo (6:01) 9. Web development on Windows (in 2019) ¢ | Demo (10:39) WSL DEEP DIVES 1. WSL on Windows 11 - Demos with Craig Loewen and Scott Hanselman | Windows Wednesday (35:48) 2. WSL and Linux Distributions - Hayden Barnes and Kayla Cinnamon | Windows Wednesday (37:00) 3. Customize your terminal with Oh My Posh and WSL Linux distros | Windows Wednesday (33:14) 4. Web dev Sarah Tamsin and Craig Loewen chat about web development, content creation, and WSL® | Dev Perspectives (12:22) 5. How WSL accesses Linux files from Windows® | Deep dive (24:59) 6. Windows subsystem for Linux architecture: a deep dive & | Build 2019 (58:10)What is Windows Terminal? Article + 12/21/2022 + 2 minutes to read Windows Terminal is a modern host application for the command-line shells you already love, like Command Prompt, PowerShell, and bash (via Windows Subsystem for Linux (WSL). Its main features include multiple tabs, panes, Unicode and UTF-8 character support, a GPU accelerated text rendering engine, and the ability to create your own themes and customize text, colors, backgrounds, and shortcuts. Install Windows Terminal https://www.microsoft.com/en-us/videoplayer/embed/RWHAdS?postislIMsg=true © Note For more general info, check out Scott Hanselman’s article: What's the difference between a console, a terminal, and a shell? or Rich Turner's video What is a command-line shell? 2 Multiple profiles supporting a variety of command line applications Any application that has a command line interface can be run inside Windows Terminal. This includes everything from PowerShell and Command Prompt to Azure Cloud Shell and any WSL distribution such as Ubuntu or Oh-My-Zsh Customized schemes and configurations You can configure your Windows Terminal to have a variety of color schemes and settings. To learn how to customize your prompt with cool themes, see Tutorial: Set up a custom prompt for PowerShell or WSL with Oh My Posh To learn how to make your own color scheme, visit the Color schemes page. Custom actions There are a variety of custom commands you can use in Windows Terminal to have it feel more natural to you. If you don't like a particular keyboard shortcut, you can changeit to whatever you prefer. For example, the default shortcut to copy text from the command line is (cteleshiftsc]. You can change this to (ctriva) or whatever you prefer. To open a new tab, the default shortcut is (cerisshiftrt), but maybe you want to change this to (ctriv2}, The default shortcut to flip between the tabs you have open is (ctristab], this could be changed to ctri+- | and used to create a new tab instead. You can learn about customizing shortcuts on the Actions page. Unicode and UTF-8 character support Windows Terminal can display Unicode and UTF-8 characters such as emoji and characters from a variety of languages. GPU accelerated text rendering Windows Terminal uses the GPU to render its text, thus providing improved performance over the default Windows command line experience. Background image support You can have background images and gifs inside your Windows Terminal window. Information on how to add background images to your profile can be found on the Profile - Appearance page. Command line arguments You can set Windows Terminal to launch in a specific configuration using command line arguments. You can specify which profile to open in a new tab, which folder directory should be selected, open the terminal with split window panes, and choose which tab should be in focus. For example, to open Windows Terminal from PowerShell with three panes, with the left pane running a Command Prompt profile and the right pane split between your PowerShell and your default profile running WSL, enter: PowerShell wt -p “Command Prompt! H wsl.exe 3 split-pane -p “Windows PowerShell” *; split-pane -Learn how to set up command-line arguments on the Command line arguments pageWindows Package Manager Article + 02/22/2022 + 2 minutes to read Windows Package Manager is a comprehensive package manager solution that consists of a command line tool and set of services for installing applications on Windows 10 and Windows 11 Windows Package Manager for developers Developers use the winget command line tool to discover, install, upgrade, remove and configure a curated set of applications. After it is installed, developers can access winget via the Windows Terminal, PowerShell, or the Command Prompt. For more information, see Use the winget tool to install and manage applications. Windows Package Manager for ISVs Independent Software Vendors (ISVs) can use Windows Package Manager as a distribution channel for software packages containing their tools and applications. To submit software packages (containing .msix, .msi, or .exe installers) to Windows Package Manager, we provide the open source Microsoft Community Package Manifest Repository on GitHub where ISVs can upload package manifests to have their software packages considered for inclusion with Windows Package Manager. Manifests are automatically validated and may also be reviewed manually. For more information, see Submit packages to Windows Package Manager. Understanding package managers A package manager is a system or set of tools used to automate installing, upgrading, configuring and using software. Most package managers are designed for discovering and installing developer tools. Ideally, developers use a package manager to specify the prerequisites for the tools they need to develop solutions for a given project. The package manager then follows the declarative instructions to install and configure the tools. The package manager reduces the time spent getting an environment ready, and it helps ensure the same versions of packages are installed on their machine.Third party package managers can leverage the Microsoft Community Package Manifest Repository to increase the size of their software catalog. Related topics © Use the winget tool to install and manage software packages * Submit packages to Windows Package ManagerUse the winget tool to install and manage applications Article + 12/14/2022 + § minutes to read 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. Install winget Windows Package Manager winget command-line tool is bundled with Windows 11 and modern versions of Windows 10 by default as the App Installer. Ifyou are running an earlier version of Windows and the App Installer is not installed, you can get App Installer from the Microsoft Store’. Ifit’s already installed, make sure it is updated with the latest version. App Installer includes the production version of the winget tool. © Note The winget command line tool is only supported on Windows 10 1709 (build 16299) or later at this time. Install winget preview version [Developers Only] To try the latest Windows Package Manager features, install the latest preview build of the winget command line tool in one of the following ways * Use a Microsoft Account (MSA), work, school or Azure Active Directory (AAD) account to sign up for the Windows Insider Dev Channel’. * Use a Microsoft Account (MSA) to sign up for the Windows Package Manager Insiders Program. * Install the Windows Desktop App Installer package located on the Releases page for the winget repository. Installing this package will give you the WinGet client, but it will not enable automatic updates from the Microsoft Store.Install winget on Windows Sandbox Windows Sandbox 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. To install winget on Windows Sandbox, follow these steps from a Windows PowerShell command prompt: PowerShell $ProgressPreference='Silent’ Invoke-WebRequest -Uri https: //github.com/microsoft /winget- cli/releases/download/v1.3.2691/Microsoft .DesktopAppInstaller_8wekyb3d8bbwe. msixbundle -OutFile .\MicrosoftDesktopAppInstaller_swekyb3d8bbwe.msixbundle Invoke-WebRequest -Uri. https: //aka.ms/[email protected] -OutFile Microsoft. VCLibs.x64.14.00, Desktop. appx Add-AppxPackage Microsoft. VCLibs.x64.14.00.Desktop.appx ‘Add-AppxPackage Microsoft .DesktopAppInstaller_swekyb3d8bbwe.msixbundle 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. Administrator considerations Installler behavior can be different depending on whether you are running winget with administrator privileges. © When running winget without administrator privileges, some applications may require elevation to install. When the installer runs, Windows will prompt you to elevate. If you choose not to elevate, the application will fail to install. © When running elevation prompts if the application requires it. Always use caution when running get in an Administrator Command Prompt, you will not see your command prompt as an administrator, and only install applications you trust. Use winget After App Installer is installed, you can run winget by typing 'winget' from a Command Prompt.One of the most common usage scenarios is to search for and install a favorite tool 1.To for a tool, type winget search 2. After you have confirmed that the tool you want is available, you can the tool by typing winget install . The winget tool will launch the installer and install the application on your PC. Wd FoweStal wend - 0 x Cer rere pa NS ee once 3. In addition to install and search, \get provides a number of other commands that enable you to on applications, , and To get a complete list of commands, type: winget --help Wd PowerShell mone - 0 x eC Siete oes es eae eo ey Saeco eres oO ee coe ewes cee ee eee CMe eer ar Some users have reported with the client not being on their PATHCommands The current preview of the winget tool supports the following commands, Command Description info Displays metadata about the system (version numbers, architecture, log location, etc). Helpful for troubleshooting. install Installs the specified application. show Displays details for the specified application. source ‘Adds, removes, and updates the Windows Package Manager repositories accessed by the winget tool. search Searches for an application. list Display installed packages. upgrade Upgrades the given package. uninstall Uninstallls the given package. hash Generates the SHA256 hash for the installer. validate Validates a manifest file for submission to the Windows Package Manager repository. settings Open settings. features Shows the status of experimental features. ‘export Exports a list of the installed packages. import Installs all the packages in a file. Options The winget tool supports the following options. Option version --info Descri Returns the current version of winget. Provides you with all detailed information on winget, including the links to the license, privacy statement, and configured group policies.Option Description Shows additional help for winget. help Supported installer formats The winget tool supports the following types of installers EXE (with Silent and SilentWithProgress flags) * INNO * NULLSOFT * MSI © APPX © MSIX * BURN © PORTABLE Scripting winget You can author batch scripts and PowerShell scripts to install multiple applications. cw @echo off Echo Install Powertoys and Terminal REM Powertoys winget install Microsoft.Powertoys if MERRORLEVEL% EQU @ Echo Powertoys installed successfully. REM Terminal winget install Microsoft .WindowsTerminal if MERRORLEVEL% EQU @ Echo Terminal installed successfully. XERRORLEVEL% © Note 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.Debugging and troubleshooting winget provides logging to help diagnose issues. For troubleshooting and details on logging, see Debugging and troubleshooting. Missing tools If the community repository does not include your tool or application, please submit a package to our repository“. By adding your favorite tool, it will be available to you and everyone else. Customize winget settings You can configure the winget command line experience by modifying the settings,json file. For more information, see 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 Open source details The winget tool is open source software available on GitHub in the repo https://github.com/microsoft/winget-cli/@. The source for building the client is located in the src folder? 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? We encourage you to contribute to the winget source on GitHub. You must first agree to and sign the Microsoft CLA. Troubleshooting The winget-cli repo maintains a list of common issues and common errors, along with recommendations on how to resolve: * common issues -- not recognized, failed to run, App Installer version or PATH variable need updating * common errors -- Error 0x801901a0, 0x80d03002, 0x80070490 7Debugging and troubleshooting issues with the winget tool Article + 11/29/2021 + 2 minutes to read When Windows Package Manager is installing, searching or listing applications, sometimes it is necessary to look at the log files to understand the behavior better. Logs Windows Package Manager by default creates log files when executing commands. These log files are located here: MD > Logs: XLOCALAPPOATAX\Packages\Microsoft.DesktopAppinstaller_8wekyb3d8bbwe\Localsta te\DiagoutputDir By navigating to this folder you will find the logs the winget tool has written --verbose-logs Ifyou need more comprehensive log files, that provide the complete communication with the CDNs and sources, include --verbose-logs on the command line as well. Here are some examples of using the --verbose-logs option: cD > winget install vscode --verbose-logs > winget search -n visual --verbose- logs > winget source add -n mysource -t Microsoft.REST -a https: //uww.contoso.org --verbose-logs Known issues A list of known issues with sources and behaviors is kept up to date in the Windows Package Manager Client repository @. If you encounter issues when using the winget tool, go here for troubleshooting.export command (winget) Article » 03/04/2022 + 2 minutes to read The export command of the winget tool exports a JSON file of apps to a specified file. The export command uses JSON as the format. The JSON schema used by winget can be found here. The export combined with the import command allows you to batch install applications on your PC. The export command is often used to create a file that you can share with other developers, or for use when restoring your build environment. Usage winget export [-o]

[] Arguments The following arguments are available. Argument Description -0,--output Path to the JSON file to be created Options The options allow you to customize the export experience to meet your needs. Option DescriptionOption Description -s,--source [Optional] Specifies a source to export files from. Use this option when you only want files from a specific source ude- [Optional] Includes the version of the app currently installed. Use this option if versions you want a specific version. By default, unless specified, import will use latest. ~-accept- Used to accept the source license agreement, and avoid the prompt. source: agreements --verbose- _Used to override the logging setting and create a verbose log, logs JSON schema The driving force behind the export command is the JSON file. You can find the schema for the JSON file here. The JSON file includes the following hierarchy. Entry Sources The sources application manifests come from. Packages The collection of packages to install Packageldentifier The Windows Package Manager package identifier used to specify the package. Version [Optional] The specific version of the package to install Exporting files When the Windows Package Manager exports the JSON file, it attempts to export all the applications installed on the PC. If the winget export command is not able to match an application to an application from an available source, the export command will show a warning © Note Matching an application depends on metadata in the manifest from a configured source, and metadata in Add / Remove Programs in Windows based on the package installer.After the export is complete, you can edit the resulting JSON file in your favorite editor. You can remove apps you do not wish to import in the future. Related topics © Use the winget tool to install and manage applicationsfeatures command (winget) Article + 08/03/2022 + 2 minutes to read The features command of the winget tool displays a list of the experimental features available with your version of the Windows Package Manager. Experimental features are only available in preview builds. Instructions for obtaining a preview build can be found in the GitHub repository. Each feature can be tuned on individually by enabling the features through settings. You can find the latest up to date information features on the experimental features web page. Usage winget features Notice above that the status of each feature is listed. If the feature is disabled you will not be able to use it. If the feature is enabled you will notice that the command will be available to you through winget. To enabled any disabled features, go to settings and enable the feature. © Note Features may be managed by group policy. You can use the winget --info command to view any policies in effect on your system.hash command (winget) Article + 03/04/2022 2 minutes to read The hash command of the winget tool generates the SHA256 hash for an installer. This command is used if you need to create a manifest file for submitting software to the Microsoft Community Package Manifest Repository on GitHub. In addition, the hash command also supports generating a SHA256 certificate hash for MSIX files Usage winget hash [--file] \ [\] The hash sub-command can only run on a local file. To use the hash sub-command, download your installer to a known location. Then pass in the file path as an argument to the hash sub-command. Arguments The following arguments are available: Argument Description -f=file The path to the file to be hashed. Specifies that the hash command will also create the SHA-256 SignatureSha256 for use with MSIX installers, --verbose- Used to override the logging setting and create a verbose log. logs -help Gets additional help on this command. Related topics * Use the winget tool to install and manage applications * Submit packages to Windows Package Managerhelp command (winget) Article + 11/01/2021 + 2 minutes to read The help command of the winget tool displays help for all the supported commands and sub commands. In addition, you can pass the --help argument to any other command to get details about all additional command options. Usage * Display help for all commands: winget --help or winget -? * View options for a command: winget --help or winget -? Related topics © Use the winget tool to install and manage applicationsimport command (winget) Article » 03/04/2022 + 2 minutes to read The import command of the winget tool imports a JSON file of apps to install. The import command combined with the export command allows you to batch install applications on your PC. The import command is often used to share your developer environment or build up your PC image with your favorite apps Usage winget import [-i] [] Arguments The following arguments are available. Argument Description import-file JSON file describing the packages to install Options The options allow you to customize the import experience to meet your needs. Option Description ignore-unavailable Suppresses errors if the app requested is unavailable.Option Description ~-ignore-versions Ignores versions specified in the JSON file and installs the latest available version ~-accept-package- Used to accept the license agreement, and avoid the prompt. agreements ~-accept-source- Used to accept the source license agreement, and avoid the prompt. agreements --verbose-logs Used to override the logging setting and create a verbose log, JSON Schema The driving force behind the import command is the JSON file. You can find the schema for the JSON file here? The JSON file includes the following hierarchy. Entry Description Sources The sources application manifests come from. Packages The collection of packages to install. Packageldentifier The Windows Package Manager package identifier used to specify the package Version [optional] The specific version of the package to install Importing files When the Windows Package Manager imports the JSON file, it attempts to install the specified applications in a serial fashion. If the application is not available or the application is already installed, it will notify the user of that case. In the previous example, the Microsoft WindowsTerminal was already installed Therefore the import command skipped the installationinfo command (winget) Article » 08/04/2022 + 2 minutes to read The info command of the winget tool displays metadata about the system, including version numbers, system architecture, log location, links to legal agreements, and Group Policy state. When submitting an issue to the winget repository on GitHub, this information is helpful for troubleshooting. It may also explain why the winget client behaves differently than expected in the case of Group Policy configuration. Usage winget --info Result fields include: * Windows Package Manager version number installed © System architecture type © MSIX package version number (winget is delivered as a part of the "App Installer" package) * Log file location * Links to privacy statement, license agreement, third party notices, homepage, and store terms* Group policy and state - this will only appear if a policy has been manually configured. (Learn more about how to configure Group Policies for Windows Package Manager‘). Related topics © Use the winget tool to install and manage applicationsinstall command (winget) Article + 08/03/2022 + 3 minutes to read The install command of the tool installs the specified application. Use the command to identify the application you want to install. The install command requires that you specify the exact string to install. If there is any ambiguity, you will be prompted to further filter the install command to an exact application. Usage winget install [[-q] \] [\] Waco Pores <2 o x Successfully installed avec] Arguments The following arguments are available. Argument Description The query used to search for an app. Get additional help on this command.© Note The query argument is positional. Wild-card style syntax is not supported. This is most often the string of characters you expect to uniquely identify the package you wish to install. Options The options allow you to customize the install experience to meet your needs. Option Description -m,--manifest Must be followed by the path to the manifest (YAML) file, You can use the manifest to run the install experience from a local YAM file. id Limits the install to the ID of the application. ~-name Limits the search to the name of the application. --moniker Limits the search to the moniker listed for the application -v, version Enables you to specify an exact version to install. f not specified, latest will install the highest versioned application. +5, --source Restricts the search to the source name provided. Must be followed by the source name. ~-scope Allows you to specify if the installer should target user or machine scope. “a, Select the architecture to install architecture -e, exact Uses the exact string in the query, including checking for case-sensitivity. It will not use the default behavior of a substring. Runs the installer in interactive mode. The default experience shows installer progress. Runs the installer in silent mode. This suppresses all Ul, The default experience shows installer progress. ~locale Specifies which locale to use (BCP47 format). -0, “log Directs the logging to a log file. You must provide a path to a file that you have the write rights to. ~-overtide A string that will be passed directly to the installer.~-accept- package- agreements --accept-source- agreements ~-header “1, rename --verbose-logs Description Location to install to (if supported). Overrides the installer hash check, Not recommended, Used to accept the license agreement, and avoid the prompt. Used to accept the source license agreement, and avoid the prompt. Optional Windows-Package-Manager REST source HTTP header. The value to rename the executable file (portable) Used to override the logging setting and create a verbose log, Example queries The following example installs a specific version of an application. cD winget install powertoys --version @.15.2 The following example installs an application from its ID. cM winget install --id Microsoft.PowerToys The following example installs an application by version and ID. cmb winget install --id Microsoft.PowerToys --version @.15.2 Multiple selections If the query provided to winget does not result in a single application, then winget will display the results of the search. This will provide you with the additional data necessary to refine the search for a correct install.The best way to limit the selection to one file is to use the id of the application combined with the exact query option. For example cmp winget install --id Git.Git -e If multiple sources are configured, it is possible to have duplicate entries. Specifying a source is required to further disambiguate cmp winget install --id Git.Git -e --source winget The msstore source uses unique identifiers as the "Id" for packages. These do not require the exact query toption, For example: cmp winget install XPOKHM4BK9FZ7Q -s msstore Local install The manifest option enables you to install an application by passing in a YAML file directly to the client. If the manifest is a multi-file manifest, the directory containing the files must be used. The manifest option has the following usage. Usage: winget install --manifest \ Option Description =m, --manifest The path to the manifests of the application to install © Note Installing packages from local manifest files may have risks. As an extra measure of precaution this feature needs to be enabled by an administrator. To enable this. feature run winget settings --enable LocalManifestFiles. To disable this feature Tun winget settings --disable LocalmanifestFiles Log filesThe log files for winget unless redirected, will be located in the following folder: Setemp%\AICLI\*log License Agreements Some applications when installed will require the user to agree to the license or other agreements before installing. When this occurs, the Windows Package Manager will prompt the user to agree to the agreements. If the user does not agree, the application will not install From the command line, you can auto accept the agreements by passing the following option --accept-package-agreements on the command line. This can be beneficial when scripting the Windows Package Manager. Related topics * Use the winget tool to install and manage applicationslist command (winget) Article * 04/05/2022 + 2 minutes to read The list command of the winget tool displays a list of the applications currently installed on your computer. The list command will show apps that were installed through the Windows Package Manager as well as apps that were installed by other means. The list command will also display if an update is available for an app, and you can use the upgrade command to update the app. The list command also supports filters which can be used to limit your list query. Usage winget list [[-q] \] [\] © Note If you want to list all apps with available updates use winget upgrade (without any arguments). Arguments The following arguments are available. Argument DescriptionArgument © Note Description The query used to search for an app. Get additional help on this command. The query argument is positional, Wild-card style syntax is not supported. This is most often the string of characters you expect to help find the installed package you are searching for. Options The options allow you to customize the list experience to meet your needs. --name --moniker +5, --source =-tag --command ~-accept-source- agreements ~-header --verbose-logs Descrip Limits the list to the ID of the application. Limits the list to the name of the application. Limits the list to the moniker listed for the application. Restricts the list to the source name provided. Must be followed by the source name. Filters results by tags. Filters results by command specified by the application Limits the number of apps displayed in one query. Uses the exact string in the list query, including checking for case-sensitivity. It will not use the default behavior of a substring Used to accept the source license agreement, and avoid the prompt. Optional Windows-Package-Manager REST source HTTP header. Used to override the logging setting and create a verbose log, Example queries The following example lists a specific version of an application,Corea eem ur ae etd Pres Pony Be Nossa Git ot omcrts Cotant me Cte eee festa emce ns Meee cr et etc) PORN Urea The following example lists all application by ID from a specific source. CeCe a ees rats crc Name Td Version Git Git.Git 2.33.0.2 Se otal The following example limits the output of list to 9 apps. Arrears PUSte Cams enna Ciesecuntstec Eom Uist carne) orient CM got era F ig ert X trig Cou Cece ee ee ceeeneaetrts List with update As stated above, the list command allows you to see what apps you have installed that have updates available. In the image below, you will notice the preview version of Terminal has an update available, il Command Prompt Terminal re eee nes The list command will show not only the update version available, but the source that the update is available from.If there are no updates available, list will only show you the currently installed version and the update column will not be displayed. © Use the winget tool to list and manage applicationssearch command (winget) Article » 08/24/2022 + 2 minutes to read The search command of the winget tool can be used to show all applications available for installation. It can also be used to identify the string or ID needed to install a specific application. For example, the command winget search vscode will return all applications available that include "vscode" in the description or tag. The search command includes parameters for filtering down the applications returned to help you identify the specific application you are looking for, including: --id, --name, =-noniker, --tag, --conmand, or --source. See descriptions below or use winget search =-help in your command line. Usage winget search [[-q] \] [\] Arguments The following arguments are available. Argument DescriptionArgument The query flag is the default argument used to search for an app. It does not need to be specified. Entering the command winget search foo will default to using --query so including it is unnecessary. Gets additional help on this command. © Note The query argument is positional, Wild-card style syntax is not supported. This is most often the string of characters you expect to help find the package you are searching for. Show all To show all of the winget packages available, use the command: winget search --query "" In PowerShell, you will need to escape the quotes, so this command becomes: Powershell winget search -q © Note This is a change from previous versions of winget which supported winget search with no filters or options displaying all available packages. You can also search for all applications in another source by passing in the source option. Search strings Search strings can be filtered with the following options. Option Description id Limits the search to the ID of the application. The ID includes the publisher and the application name.Option Description ~name Limits the search to the name of the application. --moniker Limits the search to the moniker specified. ~tag Limits the search to the tags listed for the application. --command Limits the search to the commands listed for the application. --verbose-logs Used to override the logging setting and create a verbose log. Uses the exact string in the query, including checking for case-sensitivity. It will not use the default behavior of a substring. “n, ‘Show no more than specified number of results (between 1 and 1000). source Find package using the specified source name. ~-header Optional Windows-Package-Manager REST source HTTP header. s-accept-source: Accept all source license agreements and avoid the prompt. agreements The string will be treated as a substring. The search by default is also case insensitive For example, winget search micro could return the following: * Microsoft * Microscope © MyMicro Searching across multiple sources If you want to narrow results down to a specific source, just pass the --source or -s parameter and specify what you want. For example, you might want to see if Visual Studio Code is in the store by running winget search “Visual Studio Code” -s nsstore This search uses sual Studio Code" as the query. Related topics © Use the winget tool to install and manage applicationssettings command (winget) Article + 08/03/2022 + 4 minutes to read The settings command of the winget tool allows you to customize your Windows Package Manager client experience. You can change defaults and try out experimental features that are enabled in your client. The settings command will launch your default text editor. Windows by default will launch Notepad as an option. We recommend using a tool like Visual Studio code © Note You can easily install Visual Studio Code by typing winget instal Microsoft.Visualstudiocode Use the winget settings command Launch your default JSON editing tool: winget settings When you launch the settings for the first time, there will be no settings specified, At the top of the JSON file we provide a link: where you can discover the latest experimental features and settings. The code snippet below is an example of what your settings file should look like if you would like to enable or modify some of these experimental features and settings. JSON : “https://aka.ms/winget-settings.schema. json”, // For documentation on these settings, see: https://aka.ms/winget- settings “experimentalFeatures”: { jependencies": true, irectMSI": false, ipInstall": false, » “visual”: { “progressBar": “rainbow” » “source": { “autoUpdateIntervalinMinutes": 5hb We have also defined a schema for the settings file. This allows you to use TAB to discover settings and syntax if your JSON editor supports JSON schemas © Note Experimental features are only available in preview builds. Instructions for obtaining a preview build can be found in the GitHub repository? Updating settings The following settings are available for the 1.0 release of the Windows Package Manager. source settings The source settings involve configuration to the WinGet source. JSON "source": { “autoUpdateIntervalInMinutes": 3 bs autoUpdatelntervallnMinutes A positive integer represents the update interval in minutes. The check for updates only happens when a source is used. A zero will disable the check for updates to a source. Any other values are invalid. * Disable: 0 * Default: 5 To manually update the source use winget source update visual settings The visual settings involve visual elements that are displayed by WinGetaccent” progressBar Color of the progress bar that WinGet displays when not specified by arguments. * accent (default) © retro * rainbow installBehavior settings The instal1Behavior settings affect the default behavior of installing and upgrading (where applicable) packages. disablelnstallNotes The disableInstaliNotes behavior affects whether installation notes are shown after a successful install. Defaults to false if value is not set or is invalid. JSON nstallBehavior": { "disableInstallNotes": true » portablePackageUserRoot setting The portablePackageUserRoot setting affects the default root directory where packages are installed to under User scope. This setting only applies to packages with the portable installer type. Defaults to %LOCALAPPDATAX/Mi crosoft /WinGet/Packages/ if value is not set or is invalid. Note: This setting value must be an absolute path. JSON"installBehavior": { “portablePackageUserRoot" /Users/FooBar/Packages” db» portablePackageMachineRoot setting The portablePackageMachineRoot setting affects the default root directory where packages are installed to under Machine scope. This setting only applies to packages with the portable installer type. Defaults to XPROGRAMFILESK/WinGet/Packages/ if value is not set or is invalid. Note: This setting value must be an absolute path JSON “installBehavior": { “portablePackageMachineRoot” : ‘C:/Program Files/Packages/Portable” » preferences and requirements settings Some of the settings are duplicated under preferences and requirenents © The preferences setting affects how the various available options are sorted when choosing the one to act on. For example, the default scope of package installs is for the current user, but if that is not an option then a machine level installer will be chosen. * The requirenents setting filters the options, potentially resulting in an empty list and a failure to install. In the previous example, a user scope requirement would result in no applicable installers and an error. Any arguments passed on the command line will effectively override the matching requirenent: setting for the duration of that command scope The scope behavior affects the choice between installing a package for the current user or for the entire machine. The matching parameter is --scope, and uses the same values (user or machine).JSON "installBehavior": { "preferences" locale The locale behavior affects the choice of installer based on installer locale. The matching parameter is --locale, and uses bcp47 language tag. JSON “installBehavior": ( “preferences”: { "locale": [ "en-US", "fr-FR" ] , » architectures The architectures behavior affects what architectures will be selected when installing a package. The matching parameter is --architecture. Note that only architectures compatible with your system can be selected. JSON “installgehavior": { “preferences”: { “architecture: "x64", “arm6a"] + b uninstallBehavior The uninstaliBehavior settings affect the default behavior of uninstalling (where applicable) packages. purgePortablePackageThe purgePortablePackage behavior affects the default behavior for uninstalling a portable package. If set to true, uninstall will remove all files and directories relevant to the portable package. This setting only applies to packages with the portable installer type. Defaults to false if value is not set or is invalid. JSON “uninstallBehavior": { “purgePortablePackage” : true hb telemetry settings The telemetry settings control whether winget writes ETW events that may be sent to Microsoft on a default installation of Windows. See details on telemetry”, and our primary privacy statement disable JSON “telemetry”: { If set to true, the telemetry.disable setting will prevent any event from being written by the program. network settings The network settings influence how winget uses the network to retrieve packages and metadata. downloader The downloader setting controls which code is used when downloading packages. The default is default, which may be any of the options based on our determination. wininet uses the WinlNet APIs, while do uses the Delivery Optimization’ service JSON."network": { “downloader logging settings The logging settings control the level of detail in log files. --verbose-logs will override this setting and always creates a verbose log JSON Logging’ “level 'verbose” + level The following logging levels are available. Defaults to info if the value is not set or is invalid. * verbose * info © warning © error * critical Enabling experimental features To discover which experimental features are available, go to https://aka.ms/winget- settings where you can see the experimental features available to you,show command (winget) Article » 03/04/2022 + 2 minutes to read The show command of the winget tool displays details for the specified application, including details on the source of the application as well as the metadata associated with the application. The show command only shows metadata that was submitted with the application. If the submitted application excludes some metadata, then the data will not be displayed. Usage winget show [[-q] \] [\] 2 idan Powesel we - a x ee c i Author r Pecremerret re eas cece) oe 5d eet eee tet etre eet Sear eaters Download Url - CaSO eat Nerney Arguments The following arguments are available. Argument Description The query used to search for an application. Gets additional help on this command,The query argument is positional. Wild-card style syntax is not supported. This is most often the string of characters you expect to help find the package you are searching for. Options The following options are available. opt -m,--manifest --name --moniker -v--version source -e;--exact, --versions --header ~-accept-source- agreements --verbose-logs Des« The path to the manifest of the application to install Filter results by ID. Filter results by name, Filter results by application moniker. Use the specified version. The default is the latest version. Find the application using the specified source. Find the application using exact match Show available versions of the application Optional Windows-Package-Manager REST source HTTP header. Used to accept the source license agreement, and avoid the prompt. Used to override the logging setting and create a verbose log Multiple selections If the query provided to winget does not result in a single application, then winget will display the results of the search. This will provide you with the ad. to refine the search. jonal data necessary Results of show Ifa single application is detected, the following data will be displayed. MetadataValue Description Version Version of the application. Publisher Publisher of the application Moniker AppMoniker of the application Description Description of the application. Homepage Homepage of the application. License License of the application, LicenseUrl The URL to the license file of the application. Installer details Value Type ‘The type of installer. Download Url The Url of the installer. SHA256 ‘The Sha-256 of the installer. Related topics © Use the winget tool to install and manage applicationsThe winget source command Article + 06/27/2022 + 3 minutes to read The winget tool source command allows you to manage sources for Windows Package Manager. With the source command, you can ada, list, update, remove, reset, or export repositories. A source repository provides the data for you to discover and install applications. Only use secure, trusted source locations. Windows Package Manager specifies the following two default repositories, which you can list by using winget source list ‘* msstore - The Microsoft Store catalog. * winget - The Windows Package Manager app repository. Usage winget source Arguments The following arguments are available. Argument Description “help Gets additional help on this command. The following image shows help for the source command:22. ins Pose aon ae eesetie nt er iterate The following sub- eee) roammeed Pena pas ore Subcommands The source command supports the following subcommands, ‘Subcommand Descrip' add Adds a new source. list Enumerates the list of enabled sources. update Updates a source. remove Removes a source reset Resets winget and msstore back to the initial configuration. export Exports current sources. add The add subcommand adds a new source. This subcommand requires the --name and - -arg options. Because the command changes user access, using add requires administrator privileges. Usage: cmd winget source add [-n, --name] [-a, --arg] [[-t, --type] ]For example, winget source add --name Contoso https: //wmw.contoso.con/cache adds the Contoso repository at URL https://mmw.contoso.com/cache. Optional type parameter The add subcommand supports the optional type parameter, which tells the client what type of repository it is connecting to. The following type is supported. ion Type Descr Microsoft. Preindexed. Package The default source type. list The list subcommand enumerates the currently enabled sources, or provides details on a specific source, Usage: cmd winget source list [[-n, --name] ] list all The list subcommand by itself, winget source list, provides the complete list of supported sources: Output Name Arg winget https: //winget .azureedge.net/cache list source details To get complete details about a source, pass in the name of the source. For example: cmd. winget source list --name ContosoReturns the following output: Output Name: Contoso Type: Microsoft. Preindexed. Package arg https: //pkgngr-int .azureedge.net/cache Data: ApplnstallerSQLiteIndex-int_g4ypeiskzj3Jy Updated: 2020-4-14 17:45:32.000 © Nane is the name of the source. ‘© Type is the type of repo ‘* Arg is the URL or path the source uses. * bata is the optional package name, if appropriate. © Updated is the last date and time the source was updated. update The update subcommand forces an update to an individual source, or to all sources Usage: cmd. winget source update [[-n, --name] ] update all The update subcommand by itself, winget source update, requests updates to all repos. update source The update subcommand with the --name option directs an update to the named source, For example: winget source update --nane Contoso forces an update to the Contoso repository. remove The remove subcommand removes a source. This subcommand requires the --name option to identify the source. Because the command changes user access, using remove requires administrator privileges.Usage: cmd winget source remove [-n, --name] For example: winget source renove --nane Contoso removes the Contoso repository. reset The reset subcommand resets the client back to its original configuration, and removes all sources except the default. Only use this subcommand in rare cases. Because the command changes user access, using reset requires administrator privileges. Because the reset command removes alll sources, you must force the action by using the --force option. Usage cmd winget source reset --force export The export sub-command exports the specific details for a source to JSON output. For example: cmd winget source export winget Returns the following output: :"https: //winget.azureedge.net/cache" , "Data": "Microsoft Winget .Source_ Swekyb3d8bbwe", "Identifier" :"Microsoft.Winget.Source_8wekyb3d8bbue",, "Name": " winget”, "Type": "Microsoft .PreIndexed.Package"} OptionsThe source command supports the following options. Option name “aang ~force totype ~-accept-source-agreements --header ~-verbose-logs help Description The name to identify the source by ‘The URL or UNC of the source. Used by reset to ensure that a reset is desired The type of source. Accepts the source license agreement, and avoids the prompt. Optional Windows-Package-Manager REST source HTTP header. Overrides the logging setting and creates a verbose log Gets additional help on this command. Source agreement An individual source might request that the user agree to the terms presented before adding or using the repository. If a user doesn't accept or acknowledge the agreement, they won't be able to access the source. You can use the --accept-source-agreements option to accept the source license agreement and avoid the prompt. Related topics © Use the winget tool to install and manage applicationsTab completion (winget) Article + 05/19/2022 + 2 minutes to read The winget command line tool offers a complete command to provide context-sensitive tab completion. It supports completion of command names, argument names, and argument values, dependent on the current command line state. Enable tab completion To enable tab completion with winget, you must add the following script to your SPROFILE in PowerShell, 1. Open PowerShell and enter the following command to open your $PROFILE in Notepad: notepad.exe $PROFILE 2. Copy and paste the following script into the $PROFILE file that has opened in Notepad: Register-ArgumentCompleter -Native -CommandName winget -ScriptBlock { param($wordToComplete, $conmandAst, $cursorPosition) [Console]: :InputEncoding = [Console]: :OutputEncoding = $Outputencoding = [System.Text .Utf8Encoding]: :new() $Local:word = $wordToComplete.Replace(‘"', * $Local:ast = $commandAst .ToString() .Replace( winget complete --word="$Local:word” --commandline =-position $cursorPosition | ForEach-object { [System.Management . Automation .CompletionResult]: :new($_, $_, ‘ParaneterValue’, $_) } 3 3, Save the $PROFILE with your script. Then close and reopen PowerShell. Once PowerShell has been reopened, winget tab completion will be enabled Examples of tab completion Repeated presses of tab (-») will result in cycling through the possible values Input Result ReasonInput Result winget winget install Winget sh winget show winget source 1 winget source list winget -— winget --version winget install winget install "Power power Toys" Winget install "Power winget install “Power Toys" --version Command Reference Toys" --version @.19.2 Reason install is the first command below the root shou is the first command that starts with sh List is the first sub-command of source that starts with 1 --version is the first argument defined for the root “power Toys” is the first package whose Id, Name, or Moniker starts with power 0.19.2 is the highest version of Power Toys at the time of writing The complete command takes 3 required arguments: Argument Des ‘The current word that is being completed; the token that the cursor is located --word within, Can be empty to indicate no current value at the cursor, but if provided, it must appear as a substring in the command line. G The entire current command line, including winget. See the examples above; commandline everything but the tab character (-+) should be provided to this argument. <-position The current position of the cursor in the command line. Can be greater than the length of the command line string to indicate at the end. When a word value is provided, the completion operates in replacement mode. It will suggest completions that would fit correctly at this location that also start with the given word value. When a word value is not provided (an empty value is provided for word, ex. --word=), the completion operates in insertion mode. It will suggest completions that would fit as a new value in the cursor's location. Based on the arguments, the completions suggested can be one of1. Asub command :: The cursor is located just after a command and there are sub commands available. 2. An argument specifier :: The cursor is not positioned after an argument specifier that expects a value, and there are arguments available. 3. An argument value :: The cursor is positioned after an argument specifier that expects a value, or a positional argument is expected. After evaluating all of these cases, the potential completions are output, one on each line. If the completion string contains a space, it is wrapped in quotations. Related topics * Use the winget tool to install and manage applications * Submit packages to Windows Package Manageruninstall command (winget) Article + 08/03/2022 + 2 minutes to read The uninstall command of the winget tool uninstalls the specified application The uninstall command requires that you specify the exact string to uninstall. If there is any ambiguity, you will be prompted to further filter the uninstall command to an exact application, Usage winget uninstall [[-a] \] [\] Arguments The following arguments are available. Argument Description query The query used to search for an app. help Get additional help on this command. © NoteThe query argument is positional. Wild-card style syntax is not supported. This is most often the string of characters you expect to help find the package you are uninstalling. Options The options allow you to customize the uninstall experience to meet your needs. Option -m, --manifest =-mor ~-product-code --version ~-purge ~-preserve ~-accept- source- agreements ~-header Description Must be followed by the path to the manifest (YAML) file, You can use the manifest to run the uninstall experience from a local YAM file, Limits the uninstall to the ID of the application. Limits the search to the name of the application. Limits the search to the moniker listed for the application. Filters using the product code Enables you to specify an exact version to uninstall. If not specified, latest will Uninstall the highest versioned application, Restricts the search to the source name provided. Must be followed by the source name, Uses the exact string in the query, including checking for case-sensitivity. It will hot use the default behavior of a substring. Runs the uninstaller in interactive mode. The default experience shows Uninstaller progress. Runs the uninstaller in silent mode. This suppresses all UL. The default experience shows uninstaller progress. Deletes all files and directories in the package directory (portable) Retains all files and directories created by the package (portable) Directs the logging to a log file. You must provide a path to a file that you have the write rights to. Used to accept the source license agreement, and avoid the prompt. Optional Windows-Package-Manager REST source HTTP header.Option Description --verbose-logs Used to override the logging setting and create a verbose log, After you have successfully identified the application intended to uninstall, winget will execute the uninstall command. In the example below, the name ‘orca’ and the id was passed in. Example queries The following example uninstalls a specific version of an application. cmp winget uninstall --name powertoys --version 0.15.2 The following example uninstalls an application using its ID. mp winget uninstall --id "{24559D0F -481C-F3BE-8000-0908923A38F8}" Multiple selections If the query provided to winget does not result in a single application to uninstall, then winget will display multiple results. You can then use additional filters to refine the search for a correct application, Uninstalling apps not installed with Windows Package ManagerAs mentioned in list, the winget list command will display more than just apps installed with the winget. Therefore you can use these commands to quickly and easily remove apps from your PC. In this example, list was used to find the application, and then the id was passed in as. part of uninstallupgrade command (winget) Article + 08/03/2022 + 3 minutes to read The upgrade command of the tool upgrades the specified application. Optionally, you may use the list command to identify the application you want to upgrade. The upgrade command requires that you specify the exact string to upgrade. If there is any ambiguity, you will be prompted to further filter the upgrade command to an exact application, Usage winget upgrade [[-q] \] [\] Arguments The following arguments are available. Argument Description query The query used to search for an app. -help Get additional help on this command,© Note The query argument is positional. Wild-card style syntax is not supported. This is most often the string of characters you expect to help find the package you are upgrading. Options The options allow you to customize the upgrade experience to meet your needs. Option -m, “manifest --name -v, version +s, --source --purge 0, --log --override Description Must be followed by the path to the manifest (YAML) file, You can use the manifest to run the upgrade experience from a local YAML file. Limits the upgrade to the ID of the application. Limits the search to the name of the application. Limits the search to the moniker listed for the application. Enables you to specify an exact version to upgrade. If not specified, latest will upgrade the highest versioned application. Restricts the search to the source name provided. Must be followed by the source name. Uses the exact string in the query, including checking for case-sensitivity. It will not use the default behavior of a substring. Runs the installer in interactive mode, The default experience shows installer progress. Runs the installer in silent mode, This suppresses all UI. The default experience shows installer progress. Deletes all files and directories in the package directory (portable) Directs the logging to a log file. You must provide a path to a file that you have the write rights to. Astring that will be passed directly to the installer. Location to upgrade to (if supported). When a hash mismatch is discovered will ignore the error and attempt to install the package.Option ~-accept- package- agreements ~-accept- source- agreements ~-header ~-all --include- unknown --verbose-logs Description Used to accept the license agreement, and avoid the prompt, Used to accept the source license agreement, and avoid the prompt. Optional Windows-Package-Manager REST source HTTP header. Updates all available packages to the latest application. Upgrade packages even if their current version cannot be determined. Used to override the logging setting and create a verbose log, Example queries The following example upgrades a specific version of an application. MD winget upgrade powertoys --version @.15.2 The following example upgrades an application from its 1D. cD winget upgrade --id Microsoft.PowerToys The following example shows upgrading all apps cmb winget upgrade --all Using upgrade To identify which apps are in need of an update, simply use upgrade without any arguments to show all available upgrades.In the example below, you will see winget upgrade shows the user which apps have an available update. From the available updates, the user identifies that an update is available for JanDeDobbeleer. OhMyPosh and uses upgrade to update the application. rome - a x ery Using list and upgrade To search for an available update for a specific app, use to the list command. Once you have identified that a update is available for your specific app, use upgrade to install the latest. The example below shows the list command being used to identify that an update is available for Microsoft. WindowsTerminalPreview. The user then uses upgrade to updatethe application. BB Windows Powershell PS C:\windows> winget List terminallf upgrade --all upgrade --all will identify all the applications with upgrades available. When you run winget upgrade --all the Windows Package Manager will look for all applications that have updates available and attempt to install the updates. © Note Some applications do not provide a version. They are always latest. Because the Windows Package Manager cannot identify if there is a newer version of the app, an upgrade will not be possible.validate command (winget) Article + 06/23/2022 + 2 minutes to read The validate command of the winget tool validates a manifest for submitting software to the Microsoft Community Package Manifest Repository on GitHub. The manifest must be a YAML file that follows the specification, Usage winget validate [--manifest] \ Arguments The following arguments are available. Argument Deser --manifest the path to the manifest to be validated =-verbose-logs Used to override the logging setting and create a verbose log. -help get additional help on this command Related topics © Use the winget tool to install and manage applications © Submit packages to Windows Package ManagerSubmit packages to Windows Package Manager Article + 11/29/2022 + 2 minutes to read This section provides guidance about submission process for contributing packages to Windows Package Manager (packages that can be installed with winget). Independent Software Vendor (ISV) or Publisher If you are an ISV or Publisher, you can use Windows Package Manager as a distribution channel for software packages containing your applications. Windows Package Manager currently supports installers in the following formats: MSIX, MSI, and EXE, To submit software packages to Windows Package Manager, follow these steps: 1. Create a package manifest that provides information about your application, Manifests are YAML files that follow the Windows Package Manager schema 2. Submit your manifest to the Windows Package Manager repository. This is an open source repository on GitHub that contains a collection of manifests that the winget tool can access. Ensure your submission adheres to the Windows Package Manager repository policies. Community member Ifyou are a GitHub community member, you may also submit packages to Windows Package Manager following the steps above. Optionally, you may also request help to have a package added to the community repository. To do so, create a new Package Request/Submission® issue Related topics © Use the winget tool * Create your package manifest * Submit your manifest to the repositoryCreate your package manifest Article + 09/20/2022 + 8 minutes to read Ifyou want to submit a software package to the Windows Package Manager Community Repository, start by creating a package manifest. The manifest is a YAML file that describes the application to be installed. You may either use the Windows Package Manager Manifest Creator, the YAMLCreate PowerShell script, or you can craft a manifest manually following the instructions below. © Note See the Manifest FAQ below for more general high-level information explaining manifests, packages, and versions. Options for Manifest Creation Using WinGetCreate Utility You can install the wingetcreate utility using the command below. PowerShell winget install wingetcreate After installation, you can run wingetcreate new to create a new package and fill in the prompts. The last option in the WinGetCreate prompts is to submit the manifest to the packages repository. If you choose yes, you will automatically submit your Pull Request (PR) to the Windows Package Manager Community Repository Using the YAMLCreate.ps1 To help author manifest files, we have provided a YAMLCreate.ps1 powershell script located in the Tools folder on the Windows Package Manager Community Repository? You can use the script by cloning the repo on your PC and running the script directly from the Tools folder. The script will prompt you for the URL to the installer, then will prompt you to fill in metadata. Similar to using WinGetCreate, this script will offer the option to submit your manifest automatically.YAML basics The YAML format was chosen for package manifests because of its relative ease of human readability and consistency with other Microsoft development tools. If you are not familiar with YAML syntax, you can learn the basics at Learn YAML in Y Minutes. © Note Manifests for Windows Package Manager currently do not support all YAML features. Unsupported YAML features include anchors, complex keys, and sets Conventions These conventions are used in this article: © To the left of : isa literal keyword used in manifest definitions. * To the right of : is a data type. The data type can be a primitive type like string or a reference to a rich structure defined elsewhere in this article. ‘* The notation [datatype } indicates an array of the mentioned data type. For example, [ string ] is an array of strings. * The notation { datatype : datatype } indicates a mapping of one data type to another. For example, { string: string } is a mapping of strings to strings. Manifest contents A package manifest consists of required items and optional items that can help improve the customer experience of installing your software. This section provides a brief summary of the required manifest schema and complete manifest schemas with examples of each. Each field in the manifest file must be Pascal-cased and cannot be duplicated. For a complete list and descriptions of items in a manifest, see the manifest specification in the Windows Package Manager Community Repository”, Minimal required schema As specified in the singleton JSON schema‘, only certain fields are required. The minimal supported YAML file would look like the example below. The singleton format isonly valid for packages containing a single installer and a single locale. If more than one installer or locale is provided, the multiple YAML file format and schema must be used. The partitioning scheme was added to help with GitHub’s UX. Folders with thousands of children do not render well in the browser. Minimal required schema YAML PackageIdentifier: # Publisher.package format. PackageVersion: # Version numbering format. PackageLocale: # BCP 47 format (e.g. en-US) Publisher: # The name of the publisher. PackageName: # The name of the application. License: # The license of the application. ShortDescription: # The description of the application. Installers: = Architectun # Enumeration of supported architectures. InstallerType: # Enumeration of supported installer types (exe, msi, msix, inno, wix, nullsoft, appx). InstallerUrl: # Path to download installation file. Installersha256: # SHA256 calculated from installer. ManifestType: # The manifest file type ManifestVersion: 1.0.0 Multiple manifest files To provide the best user experience, manifests should contain as much meta-data as possible, In order to separate concerns for validating installers and providing localized metadata, manifests should be split into multiple files. The minimum number of YAML files for this kind of manifest is three. Additional locales should also be provided © Aversion’? file. © The default locale file. * Aninstaller@ file. * Additional locale files. The example below shows many optional metadata fields and multiple locales. Note the default locale has more requirements than additional locales. In the show command, any required fields that aren't provided for additional locales will display fields from the default locale. Version file examplePath: manifests / m / Microsoft / WindowsTerminal / 1.6.10571.0 / Microsoft WindowsTerminalyam| YAML PackageIdentifier: "Microsoft.WindowsTerminal” PackageVersion: "1.6.10571.0" DefaultLocale: “en-US* ManifestType: “version” ManifestVersion: © Note If your installer is an .exe and it was built using Nullsoft or Inno, you may specify those values instead. When Nullsoft or Inno are specified, the client will automatically set the silent and silent with progress install behaviors for the installer. Installer switches You can often figure out what silent switches are available for an installer by passing in a =? to the installer from the command line. Here are some common silent Switches that can be used for different installer types. Installer Command Documentation Msi Ia MSI Command-Line Options Installshield /s InstallShield Command-Line Parameters? Inno Setup _/STLENT or /VERYSTLENT Inno Setup documentation? Nullsoft Is Nullsoft Silent Installers/Uninstallers Tips and best practices * The package identifier must be unique. You cannot have multiple submissions with the same package identifier. Only one pull request per package version is allowed. * Avoid creating multiple publisher folders. For example, do not create "Contoso Ltd." if there is already a "Contoso” folder.* All tools must support a silent install. If you have an executable that does not support a silent install, then we cannot provide that tool at this time. * Provide as many fields as possible. The more meta-data you provide the better the user experience will be. In some cases, the fields may not yet be supported by the Windows Package Manager client (winget.exe). For example, the Apptoniker field is optional. However, if you include this field, customers will see results associated with the Moniker value when performing the search command (for example, vscode for Visual Studio Code). If there is only one app with the specified Moniker value, customers can install your application by specifying the moniker rather than the fully qualified package identifier. * The length of strings in this specification should be limited to 100 characters before a line break. ‘© The PackageName should match the entry made in Add / Remove Programs to help the correlation with manifests to support export, and upgrade ‘* The Publisher should match the entry made in Add / Remove Programs to help the correlation with manifests to support export, and upgrade * Package installers in MSI format use product codes to uniquely identify applications. The product code for a given version of a package should be included in the manifest to help ensure the best upgrade experience. * Limit the length of strings in your manifest to 100 characters before a line break. * When more than one installer type exists for the specified version of the package, an instance of Installertype can be placed under each of the Installers Manifest FAQ What is a manifest? Manifests are YAML files containing metadata used by the Windows Package Manager to install and upgrade software on the Windows operating system. There are thousands of these files partitioned under the manifests directory in the winget-pkgs repository on GitHub. The Windows Package Manager directory structure had to be partitioned so you don't have to scroll as much in the site when looking for a manifest. What is a package? Think of a package as an application or a software program. Windows Package Manager uses a "Packageldentifier" to represent a unique package. These are generally in the form of Publisher.Package. Sometimes you might see additional values separated by a second periodWhat is a version? Package versions are associated with a specific release. In some cases you will see a perfectly formed semantic version numbers and in other cases you might see something different. These may be date driven or they might have other characters with some package-specific meaning. The YAML key for a package version is “PackageVersion’. For more information on understanding the directory structure and creating your first manifest, see Authoring Manifests@ in the winget-pkgs repo on GitHub.Submit your manifest to the repository Article + 11/29/2022 + 13 minutes to read After you create a package manifest that describes your application, you're ready to submit your manifest to the Windows Package Manager repository. This a public-facing repository that contains a collection of manifests that the winget tool can access. To submit your manifest, you'll upload it to the open source https://github.com/microsoft/winget-pkgs® repository on GitHub. After you submit a pull request to add a new manifest to the GitHub repository, an automated process will validate your manifest file and check to make sure the package complies with the Windows Package Manager polices and is not known to be malicious. If this validation is successful, your package will be added to the public-facing Windows Package Manager repository so it can be discovered by the winget client tool, Note the distinction between the manifests in the open source GitHub repository and the public- facing Windows Package Manager repository. © Important Microsoft reserves the right to refuse a submission for any reason. Manifest validation When you submit a manifest to the https://github.com/microsoft/winget-pkgs @ repository on GitHub, your manifest will be automatically validated and evaluated for the safety of the Windows ecosystem. Manifests may also be reviewed manually. For more information about the validation process, see the validation process section below. How to submit your manifest To submit a manifest to the repository, follow these steps. Step 1: Validate your manifest The winget tool provides the validate command to confirm that you have created your manifest correctly. To validate your manifest, use this command.cD winget validate \ If your validation fails, use the errors to locate the line number and make a correction. After your manifest is validated, you can submit it to the repository. Step 2: Clone the repository Next, create a fork of the repository and clone it. 1. Go to https://github.com/microsoft/winget-pkgs@ in your browser and click Fork. Owechy 5 wStar W | YFork 2 2. From a command line environment such as the Windows Command Prompt or PowerShell, use the following command to clone your fork cM git clone 3. If you are making multiple submissions, make a branch instead of a fork. We currently allow only one manifest file per submission MD git checkout -b Step 3: Add your manifest to the local repository You must add your manifest files to the repository in the following folder structure: manifests / letter / publisher / application / version * The manifests folder is the root folder for all manifests in the repository. * The letter folder is the first letter of the publisher name in the lower case. For example, m of the publisher Microsoft. © The publisher folder is the name of the company that publishes the software. For example, Microsoft ‘* The application folder is the name of the application or tool. For example, VSCode © The version folder is the version of the application or tool. For example, 1.0.0The Packagetdentifier and the PackageVersion values in the manifest must match the publisher, application names and version in the manifest folder path. For more information, see Create your package manifest. Step 4: Submit your manifest to the remote repository You're now ready to push your new manifest to the remote repository. 1. Use the conmit command to add files and commit the change and provide information on the submission. [MD git commit -m "Submitting ContosoApp version 1.0.0" --all 2. Use the push command to push the changes to the remote repository. MD git push Step 5: Create a pull request After you push your changes, return to https://github.com/microsoft/winget-pkgs@ and create a pull request to merge your fork or branch to the main branch. 2) microsoft / winget-pkgs rise Ownn~ 5 [wow | Fron @ Submission process When you create a pull request, this will start an automated process that validates the manifests and verifies your pull request. During this process we will run tests against the installer and installed binaries to validate the submission We add labels to your pull request so you can track its progress. For more information on labels and the process see the pull request labels section below. Once complete, your submission will be manually reviewed by a moderator, and after it is approved, your application will be added to the Windows Package Manager catalog.If there is ever an error during the process, you will be notified and our labels and bot will assist you in fixing your submission. For the list of common errors, see the validation process section below. Validation process When you create a pull request to submit your manifest to the Windows Package Manager repository, this will start an automation process that validates the manifest and processes your pull request. GitHub labels are used to share progress and allow you to communicate with us. Submission expectations All application submissions to the Windows Package Manager repository should adhere to the Windows Package Manager repository policies Expectations for submissions: © The manifest complies with the schema requirements. * AILURLs in the manifest lead to safe websites. © The installer and application are virus free. The package may be identified as malware by mistake. If you believe it is a false positive you can submit the installer to the Microsoft Defender team for analysis 2. * The application installs and uninstalls correctly for both administrators and non- administrators. * The installer supports non-interactive modes. * All manifest entries are accurate and not misleading. * The installer comes directly from the publisher's website. For a complete list of the policies, see Windows Package Manager policies. Pull request labels During validation, a series of labels are applied to pull requests to communicate progress, Some labels will direct you to take action, while others will be directed to the Windows Package Manager engineering team. Status labels The following table describes the status labels you might encounter.Label Details Azure- The manifest has completed the test pass. It is waiting for approval. Ifno issues are Pipeline- encountered during the test pass it will automatically be approved. If a test fails, it Passed may be flagged for manual review. Blocking- This label indicates that the pull request cannot be approved because there is a Issue blocking issue. You can often tell what the blocking issue is by the included error label Needs- This label indicates that the pull request needs to be investigated by the Windows Attention Package Manager development team. This is either due to a test failure that needs manual review, or a comment added to the pull request by the community. Needs- Indicates there is a failure with the submission. We will reassign the pull request Author back to you. If you do not address the issue within 10 days, the bot will close the Feedback pull request. Needs-Author-Feedback labels are typically added when there was a failure with the pull request that should be updated, or if the person reviewing the pull request has a question. Validation- Indicates that the test pass has been completed successfully and your pull request Completed will be merged. Error labels The following table describes the error labels you might encounter. Not all of the error cases will be assigned to you immediately. Some may trigger manual validation. Label Binary- Validation- Error Error: Analysis- Timeout Error-Hash- Mismatch Error- Installer- Availability Details The application included in this pull request failed to pass the Installers Scan test. This test is designed to ensure that the application installs on all environments without warnings. For more details on this error, see the Binary validation error section below. The Binary-Validation-Test test timed out. The pull request will get assigned to a Windows Package Manager engineer to investigate. The submitted manifest could not be processed because the InstallerSha256 hash provided for the InstallerURL did not match, Update the InstallerSha256 in the pull request and try again. The validation service was unable to download the installer. This may be related to Azure IP ranges being blocked, or the installer URL may be incorrect. Check that the InstallerURL is correct and try again. If you feel this has failed in error, add a comment and the pull request will get assigned to a Windows Package Manager engineer to investigate.Label Manifest- Installer- Validation Error Manifest- Path-Error Manifest- Validation Error PullRequest- Error URL- Validation Error Validation- Defender- Error Validation Domain Validation Error Validation Executable- Error Details There are either inconsistencies or values not present in the manifest during the evaluation of an MSIX package The manifest files must be put into a specific folder structure. This label indicates a problem with the path of your submission. For example, the folder structure does not have the required format, Update your manifest and path resubmit your pull request. The submitted manifest contains a syntax error. Address the syntax issue with the manifest and re-submit. For details on the manifest format and schema, see required format. The pulll request is invalid because not all files submitted are under manifest folder or there is more than one package or version in the pull request. Update your pull request to address the issue and try again. The URLs Validation Test could not locate the URL and responded with a HTTP error status code (403 or 404), or the URL reputation test failed. You can identify which URL is in question by looking at the pull request check details. To address this issue, update the URLs in question to resolve the HTTP error status code. If the issue is not due to an HTTP error status code, you can submit the URL for review? to avoid the reputation failure, During dynamic testing, Microsoft Defender reported a problem. To reproduce this problem, install your application, then run a Microsoft Defender full scan. If you can reproduce the problem, fix the binary or submit it for analysis for false positive assistance. If you are unable to reproduce the problem, add a comment to get the Windows Package Manager engineers to investigate. The test has determined the domain if the InstallerURL does not match the domain expected. The Windows Package Manager policies requires that the InstallerUrl comes directly from the ISV's release location. if you believe this is a false detection, add a comment to the pull request to get the Windows Package Manager engineers to investigate. Validation of the Windows Package Manager failed during manual approval. Look at the accompanying comment for next steps. During installation testing, the test was unable to locate the primary application, Make sure the application installs correctly on all platforms. If your application does not install an application, but should still be included in the repository, add a comment to the pull request to get the Windows Package Manager engineers to investigateLabel Validation- Hash- Verification- Failed Validation- HTTP-Error Validation- Indirect-URL Validation- Installation- Error Validation- Merge- Conflict Validation- MSIX- Dependency Validation- Unapproved- URL Validation Unattended- Failed Validation Uninstall- Error Validation- vcRuntime- Dependency Details During installation testing, the application fails to install because the InstallerSha256 no longer matches the InstallerURL hash. This can occur if the application is behind a vanity URL and the installer was updated without updating the InstallerSha256. To address this issue, update the InstallerSha256 associated with the InstallerURL and submit again. The URL used for the installer does not use the HTTPS protocol. Update the InstallerURL to use HTTPS and resubmit the Pull Request. The URL is not coming directly from the ISVs server. Testing has determined a redirector has been used. This is not allowed because the Windows Package Manager policies require that the InstallerUrl comes directly from the ISV's release location. Remove the redirection and resubmit. During manual validation of this package, there was a general error. Look at the accompanying comment for next steps. This package could not be validated due to a merge conflict Please address the merge conflict and resubmit your pull request. The MSIX package has a dependency on package that could not be resolved. Update the package to include the missing components or add the dependency to the manifest file and resubmit the pull request. The test has determined the domain if the InstallerURL does not match the domain expected, The Windows Package Manager policies requires that the InstallerUrl comes directly from the ISV's release location. During installation, the test timed out. This most likely is due to the application not installing silently. It could also be due to some other error being encountered and stopping the test. Verify that you can install your manifest without user input, Ifyou need assistance, add a comment to the pull request and the Windows Package Manager engineers will investigate. During uninstall testing, the application did not clean up completely following uninstall. Look at the accompanying comment for more details. The package has a dependency on the C+-+ runtime that could not be resolved, Update the package to include the missing components or add the dependency to the manifest file and resubmit the pull request. Content policy labelsThe following table lists content policy labels. If one of these labels is added, something in the manifest metadata triggered additional manual content review to ensure that the metadata is following the Windows Package Manager policies Label Policy-Test-2.1 Policy-Test-2.2 Policy-Test-2.3 Policy-Test-2.4 Policy-Test-2.5 Policy-Test-2.6 Policy-Test-2.7 Policy-Test-2.8 Policy-Test-2.9 Policy-Test-2.10 Policy-Test-2.11 Policy-Test-2.12 Internal labels Details See General Content Requirements. See Content including Names, Logos, Original and Third Party See Risk of Harm. See Defamatory, Libelous, Slanderous and Threatening, See Offensive Content, See Alcohol, Tobacco, Weapons and Drugs. See Adult Content. See Illegal Activity. See Excessive Profanity and Inappropriate Content. See Country/Region Specific Requirements. See Age Ratings. See User Generated Content. The following table lists internal error labels. When internal errors are encountered, your pull request will be assigned to the Windows Package Manager engineers to investigate. Label Details Internal-Error-Domain ‘An error occurred during the domain validation of the URL. Internal-Error-Dynamic-Scan An error occurred during the validation of the installed binaries. Internal-Error-Keyword- An error occurred during the validation of the manifest. Policy Internal-Error-Manifest ‘An error occurred during the validation of the manifest. Internal-Error- NoArchitectures An error occurred because the test could not determine the architecture if the application.Label Details Internal-Error- An error occurred because the current architecture is not NoSupportedArchitectures supported. Internal-Error-PR An error occurred during the processing of the pull request. Internal-Error-Static-Scan An error occurred during static analysis of the installers. Internal-Error-URL ‘An error occurred during reputation validation of the installers. Internal-Error A generic failure or unknown error was encountered during the test pass. Binary validation error If validation of your Pull Request fails the Installers Scan test and receives a Binary- Validation-Error label, it means that your application failed to install on all environments. Installers Scan test To provide an excellent application installation user experience, the Windows Package Manager must ensure that all applications install on PCs without errors, regardless of environment. One key test is to ensure that all applications install without warnings on various popular antivirus configurations. Windows provides the built-in Microsoft Defender antivirus program, but many enterprise customers and users use other antivirus software. Each submission to the Windows Package Manager Repository is run through several antivirus programs. These programs all have different virus detection algorithms for identifying potentially unwanted applications (PUA) and malware. Address binary validation errors If an application fails validation, Microsoft first attempts to verify with the antivirus vendor whether the flagged software is a false positive. In many cases, after notification and validation, the antivirus vendor updates their algorithm, and the application passes. In some cases, the antivirus vendor can't determine whether the detected code anomaly is a false positive. In this case, the application can't be added to the Windows Package Manager repository. The pull request is rejected with a Binary-Validation-Error label.If you get a Binary-Validation-Error label on your pull request, update your software to remove the code detected as PUA. Sometimes, genuine tools used for debugging and low-level activities appear as PUA to antivirus software, This is because the necessary debugging code has a similar signature to unwanted software. Even though this coding practice is legitimate, the Windows Package Manager repository unfortunately can't allow these applications. Submission Troubleshooting If your Windows Package Manager submission fails, you can use the labels described above to investigate the reason for the failure. To investigate pull request failures, take the following steps: 1. A pull request failure appears at the bottom of the web page with the string Some checks were not successful. Select the Details link next to a failed validation to go to the Azure Pipelines page. @ Foviow eave © seme ctects nae nt success idea checks XS Wincetsvewdtion Fling ate 2m — Bu eee = Xs Wincetiv Wktion wands Contr ation) fang ae 4s— Manes Corer aition = YG wince vin Pont Vaation) Suef in 3 scented ets YG Wincesre- whan Pu Request WEdton) Sues ip Ym — Pa Raq Valid 7 ats YB Bearer ac. regions at. ets i blocked @ Mrs 2. On the Azure Pipelines page, select the 0 errors / 0 warnings link. Azure pein ‘Azure Pipeline /WinGetSv- Validation Manifest Content Validation) X Winget-Validation tow Eee Manifest Content Validation failed Y Wingetve-Validation Poet Va. [Deron] Owarnnge Y WinGetse-Vlidtion (ul Ree a . " 3. On the next page, select the failed job.Omiccsotninge pgs sobs © Poxvastion 4, The next page shows the output for the failed job. The output should help you identify the change you need to make to fix the manifest. In the following example, the failure was during the Installation Validation task. © Jobs in run #WinGetSve-Valida. eed eu. © trate tion OreSubmit your manifest to the repository Article + 11/29/2022 + 13 minutes to read After you create a package manifest that describes your application, you're ready to submit your manifest to the Windows Package Manager repository. This a public-facing repository that contains a collection of manifests that the winget tool can access. To submit your manifest, you'll upload it to the open source https://github.com/microsoft/winget-pkgs® repository on GitHub. After you submit a pull request to add a new manifest to the GitHub repository, an automated process will validate your manifest file and check to make sure the package complies with the Windows Package Manager polices and is not known to be malicious. If this validation is successful, your package will be added to the public-facing Windows Package Manager repository so it can be discovered by the winget client tool, Note the distinction between the manifests in the open source GitHub repository and the public- facing Windows Package Manager repository. © Important Microsoft reserves the right to refuse a submission for any reason. Manifest validation When you submit a manifest to the https://github.com/microsoft/winget-pkgs @ repository on GitHub, your manifest will be automatically validated and evaluated for the safety of the Windows ecosystem. Manifests may also be reviewed manually. For more information about the validation process, see the validation process section below. How to submit your manifest To submit a manifest to the repository, follow these steps. Step 1: Validate your manifest The winget tool provides the validate command to confirm that you have created your manifest correctly. To validate your manifest, use this command.cD winget validate \ If your validation fails, use the errors to locate the line number and make a correction. After your manifest is validated, you can submit it to the repository. Step 2: Clone the repository Next, create a fork of the repository and clone it. 1. Go to https://github.com/microsoft/winget-pkgs@ in your browser and click Fork. Owechy 5 wStar W | YFork 2 2. From a command line environment such as the Windows Command Prompt or PowerShell, use the following command to clone your fork cM git clone 3. If you are making multiple submissions, make a branch instead of a fork. We currently allow only one manifest file per submission MD git checkout -b Step 3: Add your manifest to the local repository You must add your manifest files to the repository in the following folder structure: manifests / letter / publisher / application / version * The manifests folder is the root folder for all manifests in the repository. * The letter folder is the first letter of the publisher name in the lower case. For example, m of the publisher Microsoft. © The publisher folder is the name of the company that publishes the software. For example, Microsoft ‘* The application folder is the name of the application or tool. For example, VSCode © The version folder is the version of the application or tool. For example, 1.0.0‘The Packagetdentifier and the PackageVersion values in the manifest must match the publisher, application names and version in the manifest folder path. For more information, see Create your package manifest. Step 4: Submit your manifest to the remote repository You're now ready to push your new manifest to the remote repository. 1. Use the commit command to add files and commit the change and provide information on the submission. [MD git commit -m "Submitting ContosoApp version 1.0.0" --all 2. Use the push command to push the changes to the remote repository. MD git push Step 5: Create a pull request After you push your changes, return to https://github.com/microsoft/winget-pkgs@ and create a pull request to merge your fork or branch to the main branch. 2) microsoft / winget-pkgs rise Ownn~ 5 [wow | Fron @ Submission process When you create a pull request, this will start an automated process that validates the manifests and verifies your pull request. During this process we will run tests against the installer and installed binaries to validate the submission We add labels to your pull request so you can track its progress. For more information on labels and the process see the pull request labels section below. Once complete, your submission will be manually reviewed by a moderator, and after it is approved, your application will be added to the Windows Package Manager catalog.If there is ever an error during the process, you will be notified and our labels and bot will assist you in fixing your submission. For the list of common errors, see the validation process section below. Validation process When you create a pull request to submit your manifest to the Windows Package Manager repository, this will start an automation process that validates the manifest and processes your pull request. GitHub labels are used to share progress and allow you to communicate with us. Submission expectations All application submissions to the Windows Package Manager repository should adhere to the Windows Package Manager repository policies Expectations for submissions: © The manifest complies with the schema requirements. * AILURLs in the manifest lead to safe websites. © The installer and application are virus free. The package may be identified as malware by mistake. If you believe it is a false positive you can submit the installer to the Microsoft Defender team for analysis 2. * The application installs and uninstalls correctly for both administrators and non- administrators. * The installer supports non-interactive modes. * All manifest entries are accurate and not misleading. * The installer comes directly from the publisher's website. For a complete list of the policies, see Windows Package Manager policies. Pull request labels During validation, a series of labels are applied to pull requests to communicate progress, Some labels will direct you to take action, while others will be directed to the Windows Package Manager engineering team. Status labels The following table describes the status labels you might encounter.Label Details Azure- The manifest has completed the test pass. It is waiting for approval. Ifno issues are Pipeline- encountered during the test pass it will automatically be approved. If a test fails, it Passed may be flagged for manual review. Blocking- This label indicates that the pull request cannot be approved because there is a Issue blocking issue. You can often tell what the blocking issue is by the included error label Needs- This label indicates that the pull request needs to be investigated by the Windows Attention Package Manager development team. This is either due to a test failure that needs manual review, or a comment added to the pull request by the community. Needs- Indicates there is a failure with the submission. We will reassign the pull request Author back to you. If you do not address the issue within 10 days, the bot will close the Feedback pull request. Needs-Author-Feedback labels are typically added when there was a failure with the pull request that should be updated, or if the person reviewing the pull request has a question. Validation- Indicates that the test pass has been completed successfully and your pull request Completed will be merged Error labels The following table describes the error labels you might encounter. Not all of the error cases will be assigned to you immediately. Some may trigger manual validation. Label Binary- Validation- Error Error: Analysis- Timeout Error-Hash- Mismatch Error- Installer- Availability Details The application included in this pull request failed to pass the Installers Scan test. This test is designed to ensure that the application installs on all environments without warnings. For more details on this error, see the Binary validation error section below. The Binary-Validation-Test test timed out. The pull request will get assigned to a Windows Package Manager engineer to investigate. The submitted manifest could not be processed because the InstallerSha256 hash provided for the InstallerURL did not match, Update the InstallerSha256 in the pull request and try again. The validation service was unable to download the installer. This may be related to Azure IP ranges being blocked, or the installer URL may be incorrect. Check that the InstallerURL is correct and try again. If you feel this has failed in error, add a comment and the pull request will get assigned to a Windows Package Manager engineer to investigate.Label Manifest- Installer- Validation Error Manifest- Path-Error Manifest- Validation Error PullRequest- Error URL- Validation Error Validation- Defender- Error Validation Domain Validation Error Validation Executable- Error Details There are either inconsistencies or values not present in the manifest during the evaluation of an MSIX package. The manifest files must be put into a specific folder structure. This label indicates a problem with the path of your submission. For example, the folder structure does not have the required format, Update your manifest and path resubmit your pull request. The submitted manifest contains a syntax error. Address the syntax issue with the manifest and re-submit. For details on the manifest format and schema, see required format. The pull request is invalid because not all files submitted are under manifest folder or there is more than one package or version in the pull request. Update your pull request to address the issue and try again. The URLs Validation Test could not locate the URL and responded with a HTTP error status code (403 or 404), or the URL reputation test failed. You can identify which URL is in question by looking at the pull request check details. To address this issue, update the URLs in question to resolve the HTTP error status code. If the issue is not due to an HTTP error status code, you can submit the URL for review? to avoid the reputation failure, During dynamic testing, Microsoft Defender reported a problem. To reproduce this problem, install your application, then run a Microsoft Defender full scan. If you can reproduce the problem, fix the binary or submit it for analysis for false positive assistance. If you are unable to reproduce the problem, add a comment to get the Windows Package Manager engineers to investigate. The test has determined the domain if the InstallerURL does not match the domain expected. The Windows Package Manager policies requires that the InstallerUrl comes directly from the ISV's release location. if you believe this is a false detection, add a comment to the pull request to get the Windows Package Manager engineers to investigate. Validation of the Windows Package Manager failed during manual approval. Look at the accompanying comment for next steps During installation testing, the test was unable to locate the primary application, Make sure the application installs correctly on all platforms. If your application does not install an application, but should still be included in the repository, add a comment to the pull request to get the Windows Package Manager engineers to investigateLabel Validation- Hash- Verification- Failed Validation- HTTP-Error Validation- Indirect-URL Validation- Installation- Error Validation- Merge- Conflict Validation- MSIX- Dependency Validation- Unapproved- URL Validation Unattended- Failed Validation- Uninstall- Error Validation- vcRuntime- Dependency Details During installation testing, the application fails to install because the InstallerSha256 no longer matches the InstallerURL hash. This can occur if the application is behind a vanity URL and the installer was updated without updating the InstallerSha256. To address this issue, update the InstallerSha256 associated with the InstallerURL and submit again. The URL used for the installer does not use the HTTPS protocol. Update the InstallerURL to use HTTPS and resubmit the Pull Request. The URL is not coming directly from the ISVs server. Testing has determined a redirector has been used. This is not allowed because the Windows Package Manager policies require that the InstallerUrl comes directly from the ISV's release location. Remove the redirection and resubmit. During manual validation of this package, there was a general error. Look at the accompanying comment for next steps. This package could not be validated due to a merge conflict Please address the merge conflict and resubmit your pull request. The MSIX package has a dependency on package that could not be resolved. Update the package to include the missing components or add the dependency to the manifest file and resubmit the pull request. The test has determined the domain if the InstallerURL does not match the domain expected, The Windows Package Manager policies requires that the InstallerUrl comes directly from the ISV's release location. During installation, the test timed out. This most likely is due to the application not installing silently. It could also be due to some other error being encountered and stopping the test. Verify that you can install your manifest without user input, Ifyou need assistance, add a comment to the pull request and the Windows Package Manager engineers will investigate. During uninstall testing, the application did not clean up completely following uninstall, Look at the accompanying comment for more details. The package has a dependency on the C++ runtime that could not be resolved, Update the package to incluce the missing components or add the dependency to the manifest file and resubmit the pull request. Content policy labels