As specified in the singleton JSON schema, only a number of fields are required. 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.
Warning
The singleton manifest format has been deprecated in the Windows Package Manager Community Repository. The Windows Package Manager 1.6 client still supports singleton manifests.
PackageIdentifier: # The package unique identifier
PackageVersion: # The package version
Channel: # *Not implemented* distribution channel
PackageLocale: # The package meta-data locale
Publisher: # The publisher name
PackageName: # The package name
License: # The package license
ShortDescription: # The short package description
Description: # Optional full package description
Moniker: # Optional most common package term
Tags: # Optional list of package terms
Agreements: # Optional package agreements
- AgreementLabel: # Optional agreement label
Agreement: # Optional agreement text
AgreementUrl: # Optional agreement URL
Documentations: # Optional documentation
- DocumentLabel: # Optional documentation label
DocumentUrl: # Optional documentation URL
ReleaseDate: # Optional release date
ReleaseNotes: # Optional release notes
ReleaseNotesUrl: # Optional release notes URL
PurchaseUrl: # Optional purchase URL
InstallationNotes: # Optional notes displayed upon installation
Installers: # The package installer
- Architecture: # The architecture of the installer
InstallerLocale: # Optional locale of the installer
Platform: # Optional installer supported operating system
MinimumOSVersion: # Optional installer minimum operating system version
InstallerType: # The installer type
InstallerUrl: # The installer URL
InstallerSha256: # The SHA256 hash of the installer
SignatureSha256: # Optional SHA256 hash of the MSIX signature
NestedInstallerType: # The installer type when InstallerType is an archive type
NestedInstallerFiles: # Details about the installers when InstallerType is an archive type
- RelativeFilePath: # The relative path to the nested installer file
PortableCommandAlias: # The command alias to be used for calling the package. Only applies when NestedInstallerType is 'portable'
Scope: # Optional installer scope
InstallModes: # Optional installer modes
InstallerSwitches: # Optional installer switches
Silent: # Optional installer switches for silent
SilentWithProgress: # Optional installer switches for silent with progress
Interactive: # Optional installer switches for interactive
InstallLocation: # Optional install location path
Log: # Optional installer log file path
Upgrade: # Optional installer switches for upgrade
Custom: # Optional installer switches for custom behavior
UpgradeBehavior: # Optional upgrade method
Commands: # Optional commands or aliases to run the package
Protocols: # Optional list of protocols supported by the package
FileExtensions: # Optional list of file extensions supported by the package
Dependencies: # Optional list of dependencies required by the package
- ExternalDependencies: # *Not implemented* list of external dependencies
PackageDependencies: # Optional list of package dependencies
WindowsFeatures: # Optional list of Windows feature dependencies
WindowsLibraries: # *Not implemented* list of Windows library dependencies
PackageFamilyName: # Optional MSIX package family name
Capabilities: # Optional list of MSIX package capabilities
RestrictedCapabilities: # Optional list of MSIX package restricted capabilities
InstallerAbortsTerminal: # Optional indicator for packages that abort terminal
InstallLocationRequired: # Optional indicator for packages that require install location
RequireExplicitUpgrade: # Optional indicator for packages that upgrade themselves
ElevationRequirement: # Scope required to install package
UnsupportedOSArchitectures: # Optional architectures the package is not supported on
Markets: # Optional markets the package is allowed to be installed
ExcludedMarkets: # Optional markets the package is not allowed to be installed
InstallerSuccessCodes: # Optional non-zero installer success codes
ExpectedReturnCodes: # Optional non-zero installer return codes
- InstallerReturnCode: # Optional non-zero installer return code
ReturnResponse: # Optional response for an expected return code
ReturnResponseUrl: # Optional response URL for an expected return code
ProductCode: # Optional product code of the installer
AppsAndFeaturesEntries: # Optional entries from the Add and Remove Programs (ARP) table
- DisplayName: # Optional program name shown in the ARP entry
DisplayVersion: # Optional version displayed in the ARP entry
Publisher: # Optional publisher displayed in the ARP entry
ProductCode: # Optional product code of the installer
UpgradeCode: # Optional upgrade code of the installer
InstallerType: # Optional installer type
UnsupportedArguments: # Optional list of Windows Package Manager Client arguments the installer does not support
- UnsupportedArgument: # Optional unsupported Windows Package Manager Client argument
DisplayInstallWarnings: # *Not implemented* Optional indicator for packages that are known to interfere with running application during install
InstallationMetadata: # Optional metadata for deeper installation detection
- DefaultInstallLocation: # Optional default install location for the package
Files: # Optional list of files installed by the package
- RelativeFilePath: # Optional relative path to the installed file
FileSha256: # Optional Sha256 of the installed file
FileType: # Optional installed file type. Treated as 'other' if not specified
InvocationParameter: # Optional parameter for invocable files
DisplayName: # Optional display name for invocable files
DownloadCommandProhibited: # Optional indicator for packages which cannot be downloaded for offline installation
ManifestType: singleton # The manifest type
ManifestVersion: 1.6.0 # The manifest syntax versionPackageIdentifier: Microsoft.WindowsTerminal
PackageVersion: 1.6.10571.0
PackageLocale: en-US
Publisher: Microsoft
PackageName: Windows Terminal
License: MIT
ShortDescription: The new Windows Terminal, a tabbed command line experience for Windows.
Installers:
- Architecture: x64
InstallerType: msix
InstallerUrl: https://github.com/microsoft/terminal/releases/download/v1.6.10571.0/Microsoft.WindowsTerminal_1.6.10571.0_8wekyb3d8bbwe.msixbundle
InstallerSha256: 092aa89b1881e058d31b1a8d88f31bb298b5810afbba25c5cb341cfa4904d843
SignatureSha256: e53f48473621390c8243ada6345826af7c713cf1f4bbbf0d030599d1e4c175ee
ManifestType: singleton
ManifestVersion: 1.6.0PackageIdentifier - The package unique identifier
Required Field
This key is the unique identifier for a given package. This value is generally in the form of Publisher.Package. It is case sensitive, and this value must match the folder structure under the partition directory in GitHub.
PackageVersion - The package version
Required Field
This key represents the version of the package. It is related to the specific release this manifests targets. In some cases you will see a perfectly formed semantic version number, 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 for example.
The Windows Package Manager client uses this version to determine if an upgrade for a package is available. In some cases, packages may be released with a marketing driven version, and that causes trouble with the winget upgrade command.
NOTE: The current best practice is to use the value reported in Add / Remove Programs when this version of the package is installed. In some cases, packages do not report a version resulting in an upgrade loop or other unwanted behavior. This practice may seem contrary to using semantic versioning, but it provides the best end to end experience for customers. It will take time for publishers and ISVs to migrate to semantic versioning, and some may intentionally choose to preserve other versioning schemes. In these cases, it is best practice to include the "AppsAndFeaturesEntries" section for each installer.
Channel - The distribution channel
Optional Field
This key represents the distribution channel for a package. Examples may include "stable" or "beta".
NOTE: This key is included for future use. The Windows Package Manager currently does not have any behavior associated with this key. The intent behind this key is to help disambiguate the different channels for packages lacking support for side by side installation. Some packages support having more than one package channel available on a system simultaneously; in this case it is better to use unique packages rather than channels. This key is intended to ensure the proper channel for a package is used during install and upgrade scenarios.
Description - The full package description
Optional Field
This key represents the full or long description for a package. It is not currently used in the Windows Package Manager.
NOTE: This was included for future integration with the Microsoft Store source to provide the ability to display the full package description.
Moniker - The most common package term
Optional Field
This key represents the most common term users would search for when installing or upgrading a package. If only one package uses this moniker, then the install, list and upgrade command may match with this package.
NOTE: Moniker is the third property evaluated when searching for a matching package.
Tags - List of additional package search terms
Optional Field
This key represents other common term users would search for when looking for packages.
NOTE: The best practice is to present these terms in all lower case with hyphens rather than spaces.
Agreements - List of package agreements
Optional Field
This key holds any agreements a user must accept prior to download and subsequent install or upgrade.
IMPORTANT: In the Windows Package Manager Community Repository, these are only allowed to be submitted by verified developers.
AgreementLabel - The label for a package agreement
Optional Field
This key represents the label for a package agreement.
Agreement - The text for a package agreement
Optional Field
This key represents the text or body of a package agreement.
AgreementUrl - The URL for a package agreement
Optional Field
This key represents the URL for a package agreement.
Documentations - List of documentation
Optional Field
This key holds any documentation for providing software guides such as manuals and troubleshooting URLs.
DocumentLabel - The documentation label
Optional Field
This key represents the label for a documentation.
DocumentUrl - List of documentation
Optional Field
This key represents the URL for a documentation.
ReleaseDate - The Release Date for a package.
Optional Field
This key represents the release date for a package, in RFC 3339 / ISO 8601 format, i.e. "YYYY-MM-DD".
ReleaseNotes - The Release Notes for a package.
Optional Field
This key represents release notes for a package.
ReleaseNotesUrl - The Release Notes web page for a package.
Optional Field
This key represents release notes web page for a package.
PurchaseUrl - The Purchase URL for a package.
Optional Field
This key represents the purchase url for acquiring entitlement for a package.
InstallationNotes - The Installation Notes for a package.
Optional Field
This key represents the notes displayed to the user upon completion of a package installation.
Installers - Package installer
Required Field
The key represents an installer for a package.
IMPORTANT: Many of the keys related to installers may either be at the root level of the manifest, or included in an installer. Any values provided at the root level and not specified in an installer will be inherited.
Architecture - The installer target architecture
Required Field
This key represents the hardware architecture targeted by the installer. The Windows Package Manager will attempt to determine the best architecture to use. If emulation is available and the native hardware architecture does not have a supported installer, the emulated architecture may be used.
InstallerLocale - Locale for package installer
Optional Field
This key represents the locale for an installer not the package meta-data. Some installers are compiled with locale or language specific properties. If this key is present, it is used to represent the package locale for an installer.
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
Platform - The installer supported operating system
Optional Field
This key represents the Windows platform targeted by the installer. The Windows Package Manager currently supports "Windows.Desktop" and "Windows.Universal". The Windows Package Manager client currently has no behavior associated with this property. It was added for future looking scenarios.
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
MinimumOSVersion - The installer minimum operating system version
Optional Field
This key represents the minimum version of the Windows operating system supported by the package.
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
InstallerType - Enumeration of supported installer types.
Required Field
This key represents the installer type for the package. The Windows Package Manager supports MSIX, MSI, and executable installers. Some well known formats (Inno, Nullsoft, WiX, and Burn) provide standard sets of installer switches to provide different installer experiences. Portable packages are supported as of Windows Package Manager 1.3. Zip packages are supported as of Windows Package Manager 1.5.
IMPORTANT: The Windows Package Manager does not support loose executables with the .exe or .com file extension directly. Progressive Web Applications (PWAs) and fonts are also not supported.
NOTE: The Windows Package Manager defaults to the install mode providing install progress. A best practice is to determine if one of the supported installer technologies was used to build an installer with the .exe file extension. The Windows Package Manager Manifest Creator tool can be used to determine if one of the known tools was used to build an installer with the .exe file extension.
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
InstallerUrl - The installer Url
Required Field
This key represents the URL to download the installer.
InstallerSha256 - Sha256 is required. Sha256 of the installer
Required Field
This key represents the SHA 256 hash for the installer. It is used to confirm the installer has not been modified. The Windows Package Manager will compare the hash in the manifest with the calculated hash of the installer after it has been downloaded.
NOTE: The Windows Package Manager Manifest Creator can be used to determine the SHA 256 of the installer. The winget hash <pathToInstaller> command can also be used to determine the SHA 256 of the installer.
SignatureSha256 - SignatureSha256 is recommended for appx or msix. It is the sha256 of the signature file inside the appx or msix. Could be used during streaming install if applicable.
Optional Field
This key represents the signature file (AppxSignature.p7x) inside an MSIX installer. It is used to provide streaming install for MSIX packages.
IMPORTANT: MSIX installers must be signed to be included in the Microsoft community package repository. If the installer is an MSIX this signature should be included in the manifest. The Windows Package Manager Manifest Creator can be used to determine the signature SHA 256. The winget hash <pathToInstaller> --msix command can also be used to determine the signature SHA 256.
NestedInstallerType - NestedInstallerType is required when InstallerType is an archive type such as '.zip'
Required Field
This key represents the installer type of the file within the archive which will be used as the installer.
NestedInstallerFiles - NestedInstallerFiles is required when InstallerType is an archive type such as '.zip'
Required Field
This key is a list of all the installers to be executed within an archive.
Note: This field can only contain one nested installer file unless the NestedInstallerType is 'portable'
RelativeFilePath - RelativeFilePath is required within NestedInstallerFiles
Required Field
The relative path to the installer file contained within the archive.
PortableCommandAlias - The command alias to be used for calling the package
Required Field
The alias which is added to the PATH for calling the package from the command line.
NOTE: This field is only valid when NestedInstallerType is 'portable'
Scope - Scope indicates if the installer is per user or per machine
Optional Field
This key represents the scope the package is installed under. The two configurations are "user" and "machine". Some installers support only one of these scopes while others support both via arguments passed to the installer using "InstallerSwitches".
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
InstallModes - List of supported installer modes
Optional Field
This key represents the install modes supported by the installer. The Microsoft community package repository requires a package support "silent" and "silent with progress". The Windows Package Manager also supports "interactive" installers. The Windows Package Manager client does not have any behavior associated with this key.
IMPORTANT: Some installers will attempt to install missing dependencies. If these dependencies require user interaction, the package will not be allowed into the Microsoft community package repository.
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
InstallerSwitches - Switches passed to installers
Optional Field
This key represents the set of switches passed to installers.
IMPORTANT: The Microsoft community repository currently requires support for silent and silent with progress installation. Many custom .exe installers will require the proper switches to meet this requirement. The Windows Package Manager Manifest Creator tool can be used to determine if one of the known tools was used to build an installer with the .exe file extension. In the event the tool is unable to determine the tool used to build the installer, the publisher may have documentation for the proper switches.
Silent - Silent is the value that should be passed to the installer when user chooses a silent or quiet install
Optional Field
This key represents switches passed to the installer to provide a silent install experience. These would be used when the command winget install <package> --silent is executed.
NOTE: When the Windows Package Manager installs a package using the "silent" install mode, any custom switches will also be passed to the installer. If a user applies override switches via command line via the Windows Package Manager, none of the switches from the manifest will be passed to the installer.
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
SilentWithProgress - SilentWithProgress is the value that should be passed to the installer when user chooses a non-interactive install
Optional Field
This key represents switches passed to the installer to provide a silent with progress install experience. This is intended to allow a progress indication to the user, and the indication may come from an installer UI dialogue, but it must not require user interaction to complete. The Windows Package Manager currently defaults to this install experience.
NOTE: When the Windows Package Manager installs a package using the "silent with progress" install mode, any custom switches will also be passed to the installer. If a user applies override switches via command line via the Windows Package Manager, none of the switches from the manifest will be passed to the installer.
Interactive - Interactive is the value that should be passed to the installer when user chooses an interactive install
Optional Field
This key represents switches passed to the installer to provide an interactive install experience. This is intended to allow a user to interact with the installer. These would be used when the command winget install <package> --interactive is executed.
NOTE: When the Windows Package Manager installs a package using the "interactive" install mode, any custom switches will also be passed to the installer. If a user applies override switches via command line via the Windows Package Manager, none of the switches from the manifest will be passed to the installer.
InstallLocation - InstallLocation is the value passed to the installer for custom install location.
Optional Field
This key represents the path to install the package if the installer supports installing the package in a user configurable location. The <INSTALLPATH> token can be included in the switch value so the Windows Package Manager will replace the token with the user provided path.
Log - Log is the value passed to the installer for custom log file path.
Optional Field
This key represents the path logs will be directed to if the installer supports specifying the log path in a user configurable location. The <LOGPATH> token can be included in the switch value so the Windows Package Manager will replace the token with the user provided path.
Upgrade - Upgrade is the value that should be passed to the installer when user chooses an upgrade.
Optional Field
This key represents the switches to be passed to the installer during an upgrade. This will happen only if the upgrade behavior is "install".
NOTE: If a user applies override switches via command line via the Windows Package Manager, none of the switches from the manifest will be passed to the installer.
Custom - Custom switches will be passed directly to the installer by the Windows Package Manager.
Optional Field
This key represents any switches the Windows Package Manager will pass to the installer in addition to "Silent", "SilentWithProgress", and "Interactive".
NOTE: If a user applies override switches via command line via the Windows Package Manager, none of the switches from the manifest will be passed to the installer.
UpgradeBehavior - The upgrade method
Optional Field
This key represents what the Windows Package Manager should do regarding the currently installed package during a package upgrade. If the package should be uninstalled first, the "uninstallPrevious" value should be specified. If the package should not be upgraded through WinGet, the "deny" value should be specified.
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
Commands - List of commands or aliases to run the package
Optional Field
This key represents any commands or aliases used to execute the package after it has been installed.
IMPORTANT: The Windows Package Manager does not update the path during the install workflow. In those cases, the user may need to restart their shell or terminal before the command will execute the newly installed package. The Windows Package Manager does not support any behavior related to commands or aliases.
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
Protocols - List of protocols the package provides a handler for
Optional Field
This key represents any protocols supported by the package. The Windows Package Manager does not support any behavior related to protocols handled by a package.
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
FileExtensions - List of file extensions the package could support
Optional Field
This key represents any file extensions supported by the package. The Windows Package Manager does not support any behavior related to the file extensions supported by the package.
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
Dependencies - List of dependencies needed to install or execute the package
Optional Field
This key represents any dependencies required to install or run the package.
IMPORTANT: The Windows Package Manager does not support any behavior related to dependencies.
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
ExternalDependencies - List of external package dependencies
Optional Field
This key represents any external dependencies required to install or run the package.
IMPORTANT: The Windows Package Manager does not support any behavior related to dependencies.
PackageDependencies - List of package dependencies from current source
Optional Field
This key represents any packages from the same source required to install or run the package.
IMPORTANT: The Windows Package Manager does not support any behavior related to dependencies.
WindowsFeatures - List of Windows feature dependencies
Optional Field
This key represents any Windows features required to install or run the package.
IMPORTANT: The Windows Package Manager does not support any behavior related to dependencies.
WindowsLibraries - List of Windows library dependencies
Optional Field
This key represents any Windows libraries required to install or run the package.
IMPORTANT: The Windows Package Manager does not support any behavior related to dependencies.
PackageFamilyName - PackageFamilyName for appx or msix installer. Could be used for correlation of packages across sources
Optional Field
This key represents the package family name specified in an MSIX installer. This value is used to assist with matching packages from a source to the program installed in Windows via Add / Remove Programs for list, and upgrade behavior.
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
Capabilities - List of appx or msix installer capabilities
Optional Field
This key represents the capabilities provided by an MSIX package. More information is available for App capability declarations
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
RestrictedCapabilities - List of appx or msix installer restricted capabilities
Optional Field
This key represents the restricted capabilities provided by an MSIX package.More information is available for App capability declarations
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
InstallerAbortsTerminal - Indicator for installers that abort the terminal.
Optional Field
This key represents the behavior associated with installers that abort the terminal. This most often occurs when a user is performing an upgrade of the running terminal.
NOTE: Windows Terminal no longer causes this to occur as the MSIX install behavior from the Windows Package Manager is deferred registration.
InstallLocationRequired - Indicator for packages requiring an install location to be specified.
Optional Field
This key represents the requirement to have an install location specified. These installers are known to deploy files to the location the installer is executed in.
RequireExplicitUpgrade - Indicator for packages that upgrade themselves.
Optional Field
This key identifies packages that upgrade themselves. By default, they are excluded from winget upgrade --all.
ElevationRequirement - Indicator for elevation requirements when installing or upgrading packages.
Optional Field
This key represents which scope a package is required to be executed under. Some packages require user level execution while others require administrative level execution.
UnsupportedOSArchitectures - List of unsupported architectures for a package.
Optional Field
This key represents any architectures a package is known not to be compatible with. Generally, this is associated with emulation modes.
Markets - List of supported markets for a package.
Optional Field
This key represents any markets a package may be installed in.
IMPORTANT: If a market is listed in both this key and the ExcludedMarkets key, the market will be excluded. Both keys are present to reduce the need to list the larger set of markets.
ExcludedMarkets - List of unsupported markets for a package.
Optional Field
This key represents any markets a package may not be installed in.
IMPORTANT: If a market is listed in both this key and the Markets key, the market will be excluded. Both keys are present to reduce the need to list the larger set of markets.
InstallerSuccessCodes - List of additional non-zero installer success exit codes other than known default values by the Windows Package Manager.
Optional Field
This key represents any status codes returned by the installer representing a success condition other than zero.
IMPORTANT: Some return codes indicate a reboot is suggested or required. The Windows Package Manager does not support the reboot behavior currently. Some installers will force a reboot, and the Windows Package Manager does not currently suppress reboot behavior.
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
ExpectedReturnCodes - List of additional non-zero installer exit codes other than known default values by the Windows Package Manager.
Optional Field
This key represents any status codes returned by the installer representing a condition other than zero.
IMPORTANT: Some return codes indicate a reboot is suggested or required. The Windows Package Manager does not support the reboot behavior currently. Some installers will force a reboot, and the Windows Package Manager does not currently suppress reboot behavior.
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
InstallerReturnCode - The non-zero installer exit code other than known default values by the Windows Package Manager.
Optional Field
This key represents any status code returned by the installer representing a condition other than zero. MSIX and MSI packages have well known return codes. This is primarily intended for executable installers that have custom or unique return coes that can be mapped to a return response.
ReturnResponse - The return response to be displayed in the event an expected return code is encountered.
Optional Field
This key represents a return response to display when an installer returns an expected return code. MSIX and MSI packages have well known return codes. This is primarily intended for executable installers that have custom or unique return coes that can be mapped to a return response.
NOTE: An enumerated list of values in the JSON schema must be specified for consistency of user experience.
ReturnResponseUrl - The return response URL to be displayed in the event an expected return code is encountered.
Optional Field
This key represents a return response URL to display when an installer returns an expected return code. MSIX and MSI packages have well known return codes. This is primarily intended for executable installers that have custom or unique return codes that can be mapped to a return response.
NOTE: An enumerated list of values in the JSON schema must be specified for consistency of user experience.
ProductCode - ProductCode is used for correlation of packages with manifests in configured sources.
Optional Field
This key represents the product code specified in an MSI installer. This value is used to assist with matching packages from a source to the program installed in Windows via Add / Remove Programs for list, and upgrade behavior.
NOTE: This key may be present in the root of the manifest as the default value for all installer nodes. This key may also be present in an individual installer node as well. If this key is in the manifest root and in an installer node, the value in the installer node will apply.
AppsAndFeaturesEntries - AppsAndFeaturesEntries are used to match installed packages with manifests in configured sources.
Optional Field
This key represents the values reported by Windows Apps & Features. When a package is installed, entries are made into the Windows Registry.
DisplayName - DisplayName is what is displayed in the Control Panel for installed packages.
Optional Field
This key represents the package name as displayed in Windows Apps & Features. It is used to help correlate installed packages with manifests in configured sources.
DisplayVersion - DisplayVersion is the version displayed in the Control Panel for installed packages.
Optional Field
This key represents the package version as displayed in Windows Apps & Features. It is used to help correlate installed packages with manifests in configured sources.
Note: When the PackageVersion and DisplayVersion are the same, the DisplayVersion should be omitted from the AppsAndFeaturesEntries
Publisher - Publisher is the value of the package publisher reported in the Windows registry.
Optional Field
This key represents the Publisher reported in the Windows registry. It is used to help correlate installed packages with manifests in configured sources.
ProductCode - ProductCode is used for correlation of packages with manifests in configured sources.
Optional Field
This key represents the product code for a package. It is used to help correlate installed packages with manifests in configured sources.
NOTE: This key is displayed twice for completeness. When AppsAndFeaturesEntries are specified, the ProductCode should be placed both within the installer and the AppsAndFeaturesEntries
UpgradeCode - UpgradeCode is used for correlation of packages with manifests in configured sources.
Optional Field
This key represents the upgrade code for a package. It is used to help correlate installed packages with manifests in configured sources.
InstallerType - Enumeration of supported installer types.
Optional Field
This key represents the installer type for the package. It is used to help correlate installed packages with manifests in configured sources. In some cases, an installer is an .exe based installer, but contains an MSI installer. This key will help the Windows Package Manager understand if upgrading an MSI should be performed when it is contained in an .exe installer.
NOTE: This key is displayed twice for completeness. When AppsAndFeaturesEntries are specified, the InstallerType should be placed within the installer only, unless the AppsAndFeaturesEntries represent a different InstallerType
UnsupportedArguments - List of unsupported Windows Package Manager Client arguments for an installer.
Optional Field
This key represents the list of Windows Package Manager Client arguments the installer does not support. Only the --log and --location arguments can be specified as unsupported arguments for an installer.
DisplayInstallWarnings - Indicator for displaying a warning message prior to install or upgrade.
Optional Field
This key represents whether a warning message is displayed to the user prior to install or upgrade if the package is known to interfere with any running applications.
NOTE: The DisplayInstallWarnings behavior is not implemented in the Windows Package Manager 1.6 client.
InstallationMetadata - Details about the installation.
Optional Field
This key allows for additional metadata to be used for deeper installation detection.
DefaultInstallLocation - The default installed package location.
Optional Field
This key represents the default install location for the package.
Files - The list of installed files.
Optional Field
This key represents the files installed for the package.
RelativeFilePath - The relative path to the installed file.
Optional Field
This key represents the path to the installed file relative to the default install location.
FileSha256 - The optional Sha256 of the installed file.
Optional Field
This key represents the Sha256 hash of the installed file.
FileType - The optional installed file type.
Optional Field
This key represents the type of the installed file - launch, uninstall, or other. If not specified, the file is treated as other.
InvocationParameter - Optional parameter for invocable files.
Optional Field
This key represents the parameter to use for invocable files.
DisplayName - Optional display name for invocable files
Optional Field
This key represents the display name to use for invocable files.
DownloadCommandProhibited - Optional indicator for packages which cannot be downloaded for offline installation
Optional Field
When true, this flag will prohibit the manifest from being downloaded for offline installation with the winget download command
ManifestType - The manifest type
Required Field
This key must have the value "installer". The Microsoft community package repository validation pipelines also use this value to determine appropriate validation rules when evaluating this file.
ManifestVersion - The manifest syntax version
Required Field
This key must have the value "1.6.0". The Microsoft community package repository validation pipelines also use this value to determine appropriate validation rules when evaluating this file.