Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The settings command of WinGet allows you to customize your Windows Package Manager client experience. You can change defaults and try out experimental features that are available in your client.
The settings command will launch your default JSON 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 install Microsoft.VisualStudioCode
Aliases
The following aliases are available for this command:
- config
Sub-commands
The following sub-commands are available.
Sub-Command | Description |
---|---|
export | Exports settings. |
set | Sets the value of an administrator setting. |
reset | Resets an administrator setting to its default value. |
Options
The following options are available:
Argument | Description |
---|---|
--enable | Enables the specified administrator setting. |
--disable | Disables the specified administrator setting. |
-?,--help | Shows help about the selected command. |
--wait | Prompts the user to press any key before exiting. |
--logs,--open-logs | Opens the default logs location. |
--verbose,--verbose-logs | Enables verbose logging for winget. |
--nowarn,--ignore-warnings | Suppresses warning outputs. |
--disable-interactivity | Disables interactive prompts. |
--proxy | Sets a proxy to use for this execution. |
--no-proxy | Disables the use of proxy for this execution. |
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 WinGet CLI Settings link, where you can discover the latest experimental features and settings.
The code snippet below shows an example of what your settings file might look like with visual output modifications and experimental features enabled.
{
"$schema": "https://aka.ms/winget-settings.schema.json",
"visual": {
"enableSixels": true,
"progressBar": "rainbow"
},
"experimentalFeatures": {
"experimentalARG": true,
"experimentalCMD": true
}
}
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.
Updating settings
The following settings are available for the 1.11 release of the Windows Package Manager.
source settings
The source
settings involve configuration to the WinGet source.
"source": {
"autoUpdateIntervalInMinutes": 60
},
autoUpdateIntervalInMinutes
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: 15
To manually update the source use winget source update
.
visual settings
The visual
settings involve visual elements that are displayed by WinGet
"visual": {
"enableSixels": true,
"progressBar": "rainbow"
},
progressBar
Color of the progress bar that WinGet displays when not specified by arguments.
- accent (default)
- rainbow
- retro
- sixel
- disabled
anonymizeDisplayedPaths
Replaces some known folder paths with their respective environment variables.
enableSizels
Enables output of sixel images in certain contexts.
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.
"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
preferences and requirements settings
Some of the settings are duplicated under preferences
and requirements
.
- The
preferences
setting controls 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
requirements
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 requirement
setting for the duration of that command.
scope
The scope
behavior controls 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
). See known issues relating to package installation scope.
"installBehavior": {
"preferences": {
"scope": "user"
}
},
locale
The locale
behavior controls the choice of installer based on installer locale. The matching parameter is --locale
, and uses bcp47 language tag.
"installBehavior": {
"preferences": {
"locale": [ "en-US", "fr-FR" ]
}
},
architectures
The architectures
behavior controls what architectures will be selected when installing a package. The matching parameter is --architecture
. Only architectures compatible with your system can be selected.
"installBehavior": {
"preferences": {
"architectures": ["x64", "arm64"]
}
},
installerTypes
The installerTypes
behavior controls what installer types will be selected when installing a package. The matching parameter is --installer-type
.
"installBehavior": {
"preferences": {
"installerTypes": ["msix", "msi"]
}
},
installBehavior settings
The installBehavior
settings control the default behavior of installing and upgrading (where applicable) packages.
disableInstallNotes
The disableInstallNotes
setting determines whether installation notes are shown after a successful install. Defaults to false
if value is not set or is invalid.
"installBehavior": {
"disableInstallNotes": true
},
portablePackageUserRoot setting
The portablePackageUserRoot
setting defines the default root directory for installing packages under the User
scope. This applies only to packages with the portable
installer type. Defaults to %LOCALAPPDATA%/Microsoft/WinGet/Packages/
if value is not set or is invalid.
This setting value must be an absolute path.
"installBehavior": {
"portablePackageUserRoot": "C:/Users/FooBar/Packages"
},
portablePackageMachineRoot setting
The portablePackageMachineRoot
setting defines the default root directory for installing packages under the Machine
scope. This applies only to packages with the portable
installer type. Defaults to %PROGRAMFILES%/WinGet/Packages/
if the value is not set or is invalid.
This setting value must be an absolute path.
"installBehavior": {
"portablePackageMachineRoot": "C:/Program Files/Packages/Portable"
},
defaultInstallRoot
The defaultInstallRoot
setting specifies the default install location for packages that require an explicit install path, if the install location is not specified.
maxResumes
The maxResumes
setting specifies the maximum number of resume attempts allowed for a single resume ID. This prevents continuous reboots if an installation requiring a reboot is not properly detected.
archiveExtractionMethod
The archiveExtractionMethod
setting controls how the installer extracts archives. Supported values are shellApi
and tar
.
shellApi
uses the Windows Shell API to extract archives.tar
uses the tar command to extract archives.
UninstallBehavior
The uninstallBehavior
setting controls whether the default uninstall process removes all files and directories relevant to this package. Only applies to the portable installerType
.
purgePortablePackage
The purgePortablePackage
setting controls 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.
"uninstallBehavior": {
"purgePortablePackage": true
},
ConfigureBehavior
The ConfigureBehavior
setting specifies the default root directory where PowerShell modules are installed to when applying a configuration.
downloadBehavior
The downloadBehavior
settings control the default directory where installers are downloaded to.
defaultDownloadDirectory
The defaultDownloadDirectory
setting controls the default directory where packages are downloaded to. Defaults to %USERPROFILE%/Downloads
if value is not set or is invalid.
This setting value must be an absolute path.
"downloadBehavior": {
"defaultDownloadDirectory": "C:/Users/FooBar/Downloads"
},
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
"telemetry": {
"disable": true
},
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 do
, which may be managed by Group Policy.
wininet
uses the WinINet APIs, while do
uses the Delivery Optimization service.
"network": {
"downloader": "wininet"
}
doProgressTimeoutInSeconds
The doProgressTimeoutInSeconds
specifies the number of seconds to wait without progress before fallback.
Interactivity
The Interactivity
setting controls whether interactive prompts are shown by the Windows Package Manager client.
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.
Windows developer