Skip to content

Commit c8fe1ea

Browse files
Added more info for "Installer Types" values in Settings.md. (microsoft#6067)
The current documentation on the priority orders of installer types when using `winget install` without having specified `--installer-type`, was unfortunately pretty scarce. So I've filled in most of the gaps now.
1 parent 76b777c commit c8fe1ea

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

doc/Settings.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Settings file is located in %LOCALAPPDATA%\Packages\Microsoft.DesktopAppInstalle
88

99
If you are using the non-packaged WinGet version by building it from source code, the file will be located under %LOCALAPPDATA%\Microsoft\WinGet\Settings\settings.json
1010

11+
If you are creating a settings file from scratch, make sure that the line `"$schema": "https://aka.ms/winget-settings.schema.json",` is in it.
12+
1113
## Source
1214

1315
The `source` settings involve configuration to the WinGet source.
@@ -180,7 +182,11 @@ The `architectures` behavior affects what architectures will be selected when in
180182

181183
### Installer Types
182184

183-
The `installerTypes` behavior affects what installer types will be selected when installing a package. The matching parameter is `--installer-type`.
185+
The `installerTypes` behavior affects what installer types will be selected when installing a package. It can also determine which type to install by default if a manifest has multiple types: The list is in priority order, with the first listed type being preferred over the others, and so on. This is convenient for users who for instance prefer portable packages or MSIX/AppX installations. The matching parameter is `--installer-type`, which will override the settings.
186+
187+
Allowed values as of version 1.12.470 include: `appx`, `burn`, `exe`, `font`, `inno`, `msi`, `msix`, `msstore`, `nullsoft`, `portable`, `wix`, `zip`
188+
189+
By default, and with all other properties being equal, WinGet defaults to the installer type that is listed first in the manifest's installer YAML if the package has not been installed yet. If it is already installed, the same installer type will be required to ensure a proper upgrade.
184190

185191
```json
186192
"installBehavior": {

0 commit comments

Comments
 (0)