Chocolately Commands

Updated 08262022-092631

Order: 80 xref: choco-command-list Title: List/Search Description: List/Search Command (choco list) RedirectFrom: - docs/commandslist

- docs/commands-list

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for choco uninstall)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

List/Search Command (choco list)

Chocolatey will perform a search for a package local or remote.

:memo: NOTE 100% compatible with older Chocolatey client (0.9.8.x and below) with options and switches. In most cases you can still pass options and switches with one dash (-). For more details, see how to pass arguments (choco -?).

Usage

choco find <filter> [<options/switches>]
choco list <filter> [<options/switches>]
choco search <filter> [<options/switches>]
clist <filter> [<options/switches>] (DEPRECATED, will be removed in v2.0.0)

DEPRECATION NOTICE

Starting in v2.0.0 the list command will be made local only and will only work with the installed packages. All options available for connecting to sources will be removed and can only be used when using search or find.

To avoid breakage, change any calls made to remote sources to use choco search or choco find instead. These will continue to work as usual.

Starting in v2.0.0 the shortcut clist will be removed and can not be used to list package anymore. We recommend you make sure that you always use the full command going forward (choco list).

Examples

choco list --local-only (DEPRECATED: will be default for list in v2.0.0)
choco list -li
choco list -lai
choco list --page=0 --page-size=25
choco search git
choco search git --source="'https://somewhere/out/there'"
choco search bob -s "'https://somewhere/protected'" -u user -p pass

:memo: NOTE See scripting in how to pass arguments (choco -?) for how to write proper scripts and integrations.

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

Enhanced: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred - 2: no results (enhanced)

:memo: NOTE Starting in v0.10.12, if you have the feature 'useEnhancedExitCodes' turned on, then choco will provide enhanced exit codes that allow better integration and scripting.

If you find other exit codes that we have not yet documented, please file a ticket so we can document it at https://github.com/chocolatey/choco/issues/new/choose.

See It In Action

Alternative Sources

Will be removed for the list command in v2.0.0.

Available in 0.9.10+.

WebPI

This specifies the source is Web PI (Web Platform Installer) and that we are searching for a WebPI product, such as IISExpress. If you do not have the Web PI command line installed, it will install that first and then perform the search requested. e.g. choco list --source webpi

Windows Features

This specifies that the source is a Windows Feature and we should install via the Deployment Image Servicing and Management tool (DISM) on the local machine. e.g. choco list --source windowsfeatures

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

-s, --source=VALUE Source - Source location for install. Can use special 'webpi' or 'windowsfeatures' sources. Defaults to sources. (DEPRECATION NOTICE: Will be removed for list command in v2.0.0)

-l, --lo, --local, --localonly, --local-only LocalOnly - Only search against local machine items. Ignores --source if provided.. (DEPRECATION NOTICE: Will be removed and enabled by default in v2.0.0 and removed.)

 --idonly, --id-only
 Id Only - Only return Package Ids in the list results. Available in 0.1-
   0.6+.

 --pre, --prerelease
 Prerelease - Include Prereleases? Defaults to false.

-i, --includeprograms, --include-programs IncludePrograms - Used in conjunction with LocalOnly, filters out apps chocolatey has listed as packages and includes those in the list. Defaults to false.

-a, --all, --allversions, --all-versions AllVersions - include results from all versions.

 --version=VALUE
 Version - Specific version of a package to return.

-u, --user=VALUE User - used with authenticated feeds. Defaults to empty. (DEPRECATION NOTICE: Will be removed for list command in v2.0.0)

-p, --password=VALUE Password - the user's password to the source. Defaults to empty. (DEPRECATION NOTICE: Will be removed for list command in v2.0.0)

 --cert=VALUE
 Client certificate - PFX pathname for an x509 authenticated feeds. 
   Defaults to empty. Available in 0.9.10+. (DEPRECATION NOTICE: Will be 
   removed for list command in v2.0.0)

 --cp, --certpassword=VALUE
 Certificate Password - the client certificate's password to the source. 
   Defaults to empty. Available in 0.9.10+. (DEPRECATION NOTICE: Will be 
   removed for list command in v2.0.0)

 --page=VALUE
 Page - the 'page' of results to return. Defaults to return all results. 
   Available in 0.9.10+.

 --page-size=VALUE
 Page Size - the amount of package results to return per page. Defaults 
   to 25. Available in 0.9.10+.

-e, --exact Exact - Only return packages with this exact name. Available in 0.9.10+.

 --by-id-only
 ByIdOnly - Only return packages where the id contains the search filter. 
   Available in 0.9.10+.

 --by-tag-only, --by-tags-only
 ByTagOnly - Only return packages where the search filter matches on the 
   tags. Available in 0.10.6+.

 --id-starts-with
 IdStartsWith - Only return packages where the id starts with the search 
   filter. Available in 0.9.10+.

 --order-by-popularity
 OrderByPopularity - Sort by package results by popularity. Available in 
   0.9.10+.

 --approved-only
 ApprovedOnly - Only return approved packages - this option will filter 
   out results not from the [community repository](https://community.chocolatey.org/packages). Available in 0.9.10+. 
   (DEPRECATION NOTICE: Will be removed for list command in v2.0.0)

 --download-cache, --download-cache-only
 DownloadCacheAvailable - Only return packages that have a download cache 
   available - this option will filter out results not from the community 
   repository. Available in 0.9.10+. (DEPRECATION NOTICE: Will be removed 
   for list command in v2.0.0)

 --not-broken
 NotBroken - Only return packages that are not failing testing - this 
   option only filters out failing results from the [community feed](https://community.chocolatey.org/packages). It will 
   not filter against other sources. Available in 0.9.10+. (DEPRECATION 
   NOTICE: Will be removed for list command in v2.0.0)

 --detail, --detailed
 Detailed - Alias for verbose. Available in 0.9.10+.

 --disable-repository-optimizations, --disable-package-repository-optimizations
 Disable Package Repository Optimizations - Do not use optimizations for 
   reducing bandwidth with repository queries during package 
   install/upgrade/outdated operations. Should not generally be used, 
   unless a repository needs to support older methods of query. When 
   disabled, this makes queries similar to the way they were done in 
   Chocolatey v0.10.11 and before. Overrides the default feature 
   'usePackageRepositoryOptimizations' set to 'True'. Available in 0.10.14-
   +. (DEPRECATION NOTICE: Will be removed for list command in v2.0.0)

 --audit, --showaudit, --show-audit, --show-audit-info
 Show Audit Information - Display auditing information for a package. 
   Available in business editions 1.12.0+.

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco list -h.

=== --- Order: 40 xref: choco-commands Title: Commands Description: Full list of all available Chocolatey commands RedirectFrom: - docs/commandsreference

- docs/commands-reference

Command Reference

This is a listing of all of the different things you can pass to choco.

DEPRECATION NOTICE

The shims chocolatey, cinst, clist, cpush, cuninst and cup are deprecated. We recommend updating all scripts to use their full command equivalent as these will be removed in v2.0.0 of Chocolatey.

Commands

search - searches remote or local packages (alias for list)
list - lists remote or local packages
find - searches remote or local packages (alias for search)
info - retrieves package information. Shorthand for choco search pkgname --exact --verbose
install - installs packages from various sources
pin - suppress upgrades for a package
outdated - retrieves packages that are outdated. Similar to upgrade all --noop
upgrade - upgrades packages from various sources
uninstall - uninstalls a package
pack - packages nuspec, scripts, and other Chocolatey package resources into a nupkg file
push - pushes a compiled nupkg to a source
new - generates files necessary for a chocolatey package from a template
source - view and configure default sources
sources - view and configure default sources (alias for source)
config - Retrieve and configure config file settings
feature - view and configure choco features
features - view and configure choco features (alias for feature)
setapikey - retrieves, saves or deletes an apikey for a particular source (alias for apikey)
apikey - retrieves, saves or deletes an apikey for a particular source
unpackself - re-installs Chocolatey base files
support - provides support information
help - displays top level help information for choco
export - exports list of currently installed packages
template - get information about installed templates
templates - get information about installed templates (alias for template)
download - downloads packages - optionally internalizing all remote resources
synchronize - synchronizes against system installed software - generates missing packages
sync - synchronizes against system installed software - generates missing packages
optimize - optimizes installation, reducing space usage
convert - converts packages from one type to another type

Please run chocolatey with choco command -help for specific help on each command.

How To Pass Options / Switches

You can pass options and switches in the following ways:

Unless stated otherwise, an option/switch should only be passed one time. Otherwise you may find weird/non-supported behavior.
-, /, or -- (one character switches should not use --)
Option Bundling / Bundled Options: One character switches can be bundled. e.g. -d (debug), -f (force), -v (verbose), and -y (confirm yes) can be bundled as -dfvy.
:memo: NOTE If debug or verbose are bundled with local options (not the global ones above), some logging may not show up until after the local options are parsed.
Use Equals: You can also include or not include an equals sign = between options and values.
Quote Values: When you need to quote an entire argument, such as when using spaces, please use a combination of double quotes and apostrophes ("'value'"). In cmd.exe you can just use double quotes ("value") but in powershell.exe you should use backticks (`"value`") or apostrophes ('value'). Using the combination allows for both shells to work without issue, except for when the next section applies.
Pass quotes in arguments: When you need to pass quoted values to to something like a native installer, you are in for a world of fun. In cmd.exe you must pass it like this: -ia "/yo=""Spaces spaces""". In PowerShell.exe, you must pass it like this: -ia '/yo=""Spaces spaces""'. No other combination will work. In PowerShell.exe if you are on version v3+, you can try --% before -ia to just pass the args through as is, which means it should not require any special workarounds.
Periods in PowerShell: If you need to pass a period as part of a value or a path, PowerShell doesn't always handle it well. Please quote those values using "Quote Values" section above.
Options and switches apply to all items passed, so if you are installing multiple packages, and you use --version=1.0.0, choco is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Scripting / Integration - Best Practices / Style Guide

When writing scripts, such as PowerShell scripts passing options and switches, there are some best practices to follow to ensure that you don't run into issues later. This also applies to integrations that are calling Chocolatey and parsing output. Chocolatey uses PowerShell, but it is an exe, so it cannot return PowerShell objects.

Following these practices ensures both readability of your scripts AND compatibility across different versions and editions of Chocolatey. Following this guide will ensure your experience is not frustrating based on choco not receiving things you think you are passing to it.

For consistency, always use choco, not choco.exe. Never use shortcut commands like cinst or cup (The shortcuts cinst and cup will be removed in v2.0.0).
Always have the command as the first argument to choco. e.g. choco install, where install is the command.
If there is a subcommand, ensure that is the second argument. e.g. choco source list, where source is the command and list is the subcommand.
Typically the subject comes next. If installing packages, the subject would be the package names, e.g. choco install pkg1 pkg2.
Never use 'nupkg' or point directly to a nupkg file UNLESS using 'choco push'. Use the source folder instead, e.g. choco install <package id> --source="'c:\folder\with\package'" instead of choco install DoNotDoThis.1.0.nupkg or choco install DoNotDoThis --source="'c:\folder\with\package\DoNotDoThis.1.0.nupkg'".
Switches and parameters are called simply options. Options come after the subject. e.g. choco install pkg1 --debug --verbose.
Never use the force option (--force/-f) in scripts (or really otherwise as a default mode of use). Force is an override on Chocolatey behavior. If you are wondering why Chocolatey isn't doing something like the documentation says it should, it's likely because you are using force. Stop.
Always use full option name. If the short option is -n, and the full option is --name, use --name. The only acceptable short option for use in scripts is -y. Find option names in help docs online or through choco -? /choco [Command Name] -?.
For scripts that are running automated, always use -y. Do note that even with -y passed, some things / state issues detected will temporarily stop for input - the key here is temporarily. They will continue without requiring any action after the temporary timeout (typically 30 seconds).
Full option names are prepended with two dashes, e.g. -- or --debug --verbose --ignore-proxy.
When setting a value to an option, always put an equals (=) between the name and the setting, e.g. --source="'local'".
When setting a value to an option, always surround the value properly with double quotes bookending apostrophes, e.g. --source="'internal_server'".
If you are building PowerShell scripts, you can most likely just simply use apostrophes surrounding option values, e.g. --source='internal_server'.
Prefer upgrade to install in scripts. You can't install to a newer version of something, but you can choco upgrade which will do both upgrade or install (unless switched off explicitly).
If you are sharing the script with others, pass --source to be explicit about where the package is coming from. Use full link and not source name ('https://community.chocolatey.org/api/v2' versus 'chocolatey').
If parsing output, you might want to use --limit-output/-r to get output in a more machine parseable format. > :memo: NOTE Not all commands handle return of information in an easily digestible output.
Use exit codes to determine status. Chocolatey exits with 0 when everything worked appropriately and other exits codes like 1 when things error. There are package specific exit codes that are recommended to be used and reboot indicating exit codes as well. To check exit code when using PowerShell, immediately call $exitCode = $LASTEXITCODE to get the value choco exited with.

Here's an example following bad practices (line breaks added for readability):

choco install pkg1 -y -params '/Option:Value /Option2:value with spaces' --c4b-option 'Yaass' --option-that-is-new 'dude upgrade'

Now here is that example written with best practices (again line breaks added for readability - there are not line continuations for choco):

choco upgrade pkg1 -y --source="'https://community.chocolatey.org/api/v2'" --package-parameters="'/Option:Value /Option2:value with spaces'" --c4b-option="'Yaass'" --option-that-is-new="'dude upgrade'"

Note the differences between the two: * Which is more self-documenting? * Which will allow for the newest version of something installed or upgraded to (which allows for more environmental consistency on packages and versions)? * Which may throw an error on a badly passed option? * Which will throw errors on unknown option values? See explanation below.

Chocolatey ignores options it doesn't understand, but it can only ignore option values if they are tied to the option with an equals sign ('='). Note those last two options in the examples above? If you roll off of a commercial edition or someone with older version attempts to run the badly crafted script --c4b-option 'Yaass' --option-that-is-new 'dude upgrade', they are likely to see errors on 'Yaass' and 'dude upgrade' because they are not explicitly tied to the option they are written after. Now compare that to the other script. Choco will ignore --c4b-option="'Yaass'" and --option-that-is-new="'dude upgrade'" as a whole when it doesn't register the options. This means that your script doesn't error.

Following these scripting best practices will ensure your scripts work everywhere they are used and with newer versions of Chocolatey.

See Help Menu In Action

Default Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

~~~

:memo: NOTE This documentation has been automatically generated from choco -h.

=== --- Order: 60 xref: choco-command-info Title: Info Description: Info Command (choco info) RedirectFrom: - docs/commandsinfo

- docs/commands-info

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Info Command (choco info)

Chocolatey will perform a search for a package local or remote and provide detailed information about that package. This is a synonym for choco search <pkgname> --exact --detailed.

:memo: NOTE New as of 0.9.10.0.

Usage

choco info [<options/switches>]

Examples

choco info chocolatey
choco info googlechrome
choco info powershell

:memo: NOTE See scripting in how to pass arguments (choco -?) for how to write proper scripts and integrations.

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

Enhanced: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred - 2: no results (enhanced)

:memo: NOTE Starting in v0.10.12, if you have the feature 'useEnhancedExitCodes' turned on, then choco will provide enhanced exit codes that allow better integration and scripting.

If you find other exit codes that we have not yet documented, please file a ticket so we can document it at https://github.com/chocolatey/choco/issues/new/choose.

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

-s, --source=VALUE Source - Source location for install. Can use special 'webpi' or 'windowsfeatures' sources. Defaults to sources.

-l, --lo, --localonly, --local-only LocalOnly - Only search against local machine items.

 --version=VALUE
 Version - Specific version of a package to return.

 --pre, --prerelease
 Prerelease - Include Prereleases? Defaults to false.

-u, --user=VALUE User - used with authenticated feeds. Defaults to empty.

-p, --password=VALUE Password - the user's password to the source. Defaults to empty.

 --cert=VALUE
 Client certificate - PFX pathname for an x509 authenticated feeds. 
   Defaults to empty. Available in 0.9.10+.

 --cp, --certpassword=VALUE
 Certificate Password - the client certificate's password to the source. 
   Defaults to empty. Available in 0.9.10+.

 --disable-repository-optimizations, --disable-package-repository-optimizations
 Disable Package Repository Optimizations - Do not use optimizations for 
   reducing bandwidth with repository queries during package 
   install/upgrade/outdated operations. Should not generally be used, 
   unless a repository needs to support older methods of query. When used, 
   this makes queries similar to the way they were done in Chocolatey v0.1-
   0.11 and before. Overrides the default feature 
   'usePackageRepositoryOptimizations' set to 'True'. Available in 0.10.14+.

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco info -h.

=== --- Order: 40 xref: choco-command-feature Title: Feature Description: Feature Command (choco feature) RedirectFrom: - docs/commandsfeature

- docs/commands-feature

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Feature Command (choco feature)

Chocolatey will allow you to interact with features.

Usage

choco feature [list]|disable|enable [<options/switches>]

Examples

choco feature
choco feature list
choco feature disable -n=bob
choco feature enable -n=bob

:memo: NOTE See scripting in how to pass arguments (choco -?) for how to write proper scripts and integrations.

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

If you find other exit codes that we have not yet documented, please file a ticket so we can document it at https://github.com/chocolatey/choco/issues/new/choose.

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

-n, --name=VALUE Name - the name of the source. Required with actions other than list. Defaults to empty.

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco feature -h.

=== --- Order: 35 xref: choco-command-find Title: Find Description: Find Command (choco find) RedirectFrom: - docs/commandsfind

- docs/commands-find

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

List/Search Command (choco find)

Chocolatey will perform a search for a package local or remote.

:memo: NOTE 100% compatible with older Chocolatey client (0.9.8.x and below) with options and switches. In most cases you can still pass options and switches with one dash (-). For more details, see how to pass arguments (choco -?).

Usage

choco find <filter> [<options/switches>]
choco list <filter> [<options/switches>]
choco search <filter> [<options/switches>]
clist <filter> [<options/switches>] (DEPRECATED, will be removed in v2.0.0)

Examples

choco list --local-only (DEPRECATED: will be default for list in v2.0.0)
choco list -li
choco list -lai
choco list --page=0 --page-size=25
choco search git
choco search git --source="'https://somewhere/out/there'"
choco search bob -s "'https://somewhere/protected'" -u user -p pass

:memo: NOTE See scripting in how to pass arguments (choco -?) for how to write proper scripts and integrations.

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

Enhanced: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred - 2: no results (enhanced)

:memo: NOTE Starting in v0.10.12, if you have the feature 'useEnhancedExitCodes' turned on, then choco will provide enhanced exit codes that allow better integration and scripting.

If you find other exit codes that we have not yet documented, please file a ticket so we can document it at https://github.com/chocolatey/choco/issues/new/choose.

See It In Action

Alternative Sources

Available in 0.9.10+.

WebPI

Windows Features

This specifies that the source is a Windows Feature and we should install via the Deployment Image Servicing and Management tool (DISM) on the local machine. e.g. choco find --source windowsfeatures

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

-s, --source=VALUE Source - Source location for install. Can use special 'webpi' or 'windowsfeatures' sources. Defaults to sources.

-l, --lo, --local, --localonly, --local-only LocalOnly - Only search against local machine items. Ignores --source if provided..

 --idonly, --id-only
 Id Only - Only return Package Ids in the list results. Available in 0.1-
   0.6+.

 --pre, --prerelease
 Prerelease - Include Prereleases? Defaults to false.

-i, --includeprograms, --include-programs IncludePrograms - Used in conjunction with LocalOnly, filters out apps chocolatey has listed as packages and includes those in the list. Defaults to false.

-a, --all, --allversions, --all-versions AllVersions - include results from all versions.

 --version=VALUE
 Version - Specific version of a package to return.

-u, --user=VALUE User - used with authenticated feeds. Defaults to empty.

-p, --password=VALUE Password - the user's password to the source. Defaults to empty.

 --cert=VALUE
 Client certificate - PFX pathname for an x509 authenticated feeds. 
   Defaults to empty. Available in 0.9.10+.

 --cp, --certpassword=VALUE
 Certificate Password - the client certificate's password to the source. 
   Defaults to empty. Available in 0.9.10+.

 --page=VALUE
 Page - the 'page' of results to return. Defaults to return all results. 
   Available in 0.9.10+.

 --page-size=VALUE
 Page Size - the amount of package results to return per page. Defaults 
   to 25. Available in 0.9.10+.

-e, --exact Exact - Only return packages with this exact name. Available in 0.9.10+.

 --by-id-only
 ByIdOnly - Only return packages where the id contains the search filter. 
   Available in 0.9.10+.

 --by-tag-only, --by-tags-only
 ByTagOnly - Only return packages where the search filter matches on the 
   tags. Available in 0.10.6+.

 --id-starts-with
 IdStartsWith - Only return packages where the id starts with the search 
   filter. Available in 0.9.10+.

 --order-by-popularity
 OrderByPopularity - Sort by package results by popularity. Available in 
   0.9.10+.

 --approved-only
 ApprovedOnly - Only return approved packages - this option will filter 
   out results not from the [community repository](https://community.chocolatey.org/packages). Available in 0.9.10+.

 --download-cache, --download-cache-only
 DownloadCacheAvailable - Only return packages that have a download cache 
   available - this option will filter out results not from the community 
   repository. Available in 0.9.10+.

 --not-broken
 NotBroken - Only return packages that are not failing testing - this 
   option only filters out failing results from the [community feed](https://community.chocolatey.org/packages). It will 
   not filter against other sources. Available in 0.9.10+.

 --detail, --detailed
 Detailed - Alias for verbose. Available in 0.9.10+.

 --disable-repository-optimizations, --disable-package-repository-optimizations
 Disable Package Repository Optimizations - Do not use optimizations for 
   reducing bandwidth with repository queries during package 
   install/upgrade/outdated operations. Should not generally be used, 
   unless a repository needs to support older methods of query. When 
   disabled, this makes queries similar to the way they were done in 
   Chocolatey v0.10.11 and before. Overrides the default feature 
   'usePackageRepositoryOptimizations' set to 'True'. Available in 0.10.14+.

 --audit, --showaudit, --show-audit, --show-audit-info
 Show Audit Information - Display auditing information for a package. 
   Available in business editions 1.12.0+.

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco find -h.

=== --- Order: 30 xref: choco-command-export Title: Export Description: Export Command (choco export) RedirectFrom: - docs/commandsexport

- docs/commands-export

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Export Command (choco export)

Export all currently installed packages to a file.

This is especially helpful when re-building a machine that was created using Chocolatey. Export all packages to a file, and then re-install those packages onto new machine using choco install packages.config.

:memo: NOTE Available with 0.11.0+.

Usage

choco export [<options/switches>]

Examples

choco export
choco export --include-version-numbers
choco export "'c:\temp\packages.config'"
choco export "'c:\temp\packages.config'" --include-version-numbers
choco export -o="'c:\temp\packages.config'"
choco export -o="'c:\temp\packages.config'" --include-version-numbers
choco export --output-file-path="'c:\temp\packages.config'"
choco export --output-file-path="'c:\temp\packages.config'" --include-version-numbers

:memo: NOTE See scripting in how to pass arguments (choco -?) for how to write proper scripts and integrations.

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

If you find other exit codes that we have not yet documented, please file a ticket so we can document it at https://github.com/chocolatey/choco/issues/new/choose.

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

-o, --output-file-path=VALUE Output File Path - the path to where the list of currently installed packages should be saved. Defaults to packages.config.

 --include-version-numbers, --include-version
 Include Version Numbers - controls whether or not version numbers for 
   each package appear in generated file.  Defaults to false.

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco export -h.

=== --- Order: 220 xref: choco-command-upgrade Title: Upgrade Description: Upgrade Command (choco upgrade) RedirectFrom: - docs/commandsupgrade

- docs/commands-upgrade

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for choco uninstall)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Upgrade Command (choco upgrade)

Upgrades a package or a list of packages. If you do not have a package installed, upgrade will install it.

:memo: NOTE 100% compatible with older Chocolatey client (0.9.8.x and below) with options and switches. Add -y for previous behavior with no prompt. In most cases you can still pass options and switches with one dash (-). For more details, see how to pass arguments (choco -?).

DEPRECATION NOTICE

Starting in v2.0.0 the shortcut cup will be removed and can not be used to upgrade or install packages anymore. We recommend you make sure that you always use the full command going forward (choco upgrade).

Usage

choco upgrade <pkg|all> [<pkg2> <pkgN>] [<options/switches>]
cup <pkg|all> [<pkg2> <pkgN>] [<options/switches>] (DEPRECATED, will be removed in v2.0.0)

:memo: NOTE all is a special package keyword that will allow you to upgrade all currently installed packages.

Skip upgrading certain packages with choco pin or with the option --except.

:memo: NOTE Chocolatey Pro / Business automatically synchronizes with Programs and Features, ensuring automatically updating apps' versions (like Chrome) are up to date in Chocolatey's repository.

Examples

choco upgrade chocolatey
choco upgrade notepadplusplus googlechrome atom 7zip
choco upgrade notepadplusplus googlechrome atom 7zip -dvfy
choco upgrade git -y --params="'/GitAndUnixToolsOnPath /NoAutoCrlf'"
choco upgrade git -y --params="'/GitAndUnixToolsOnPath /NoAutoCrlf'" --install-args="'/DIR=C:\git'"
# Params are package parameters, passed to the package
# Install args are installer arguments, appended to the silentArgs 
#  in the package for the installer itself
choco upgrade nodejs.install --version 0.10.35
choco upgrade git -s "'https://somewhere/out/there'"
choco upgrade git -s "'https://somewhere/protected'" -u user -p pass
choco upgrade all
choco upgrade all --except="'skype,conemu'"

:memo: NOTE See scripting in how to pass arguments (choco -?) for how to write proper scripts and integrations.

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

Package Exit Codes: - 1641: success, reboot initiated - 3010: success, reboot required - other (not listed): likely an error has occurred

In addition to normal exit codes, packages are allowed to exit with their own codes when the feature 'usePackageExitCodes' is turned on. Uninstall command has additional valid exit codes. Available in v0.9.10+.

Reboot Exit Codes: - 350: pending reboot detected, no action has occurred - 1604: install suspended, incomplete

In addition to the above exit codes, you may also see reboot exit codes when the feature 'exitOnRebootDetected' is turned on. It typically requires the feature 'usePackageExitCodes' to also be turned on to work properly. Available in v0.10.12+.

See It In Action

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

-s, --source=VALUE Source - The source to find the package(s) to install. Special sources include: ruby, webpi, cygwin, windowsfeatures, and python. To specify more than one source, pass it with a semi-colon separating the values (- e.g. "'source1;source2'"). Defaults to default feeds.

 --version=VALUE
 Version - A specific version to install. Defaults to unspecified.

 --pre, --prerelease
 Prerelease - Include Prereleases? Defaults to false.

 --x86, --forcex86
 ForceX86 - Force x86 (32bit) installation on 64 bit systems. Defaults to 
   false.

 --ia, --installargs, --install-args, --installarguments, --install-arguments=VALUE
 InstallArguments - Install Arguments to pass to the native installer in 
   the package. Defaults to unspecified.

-o, --override, --overrideargs, --overridearguments, --override-arguments OverrideArguments - Should install arguments be used exclusively without appending to current package passed arguments? Defaults to false.

 --notsilent, --not-silent
 NotSilent - Do not install this silently. Defaults to false.

 --params, --parameters, --pkgparameters, --packageparameters, --package-parameters=VALUE
 PackageParameters - Parameters to pass to the package. Defaults to 
   unspecified.

 --argsglobal, --args-global, --installargsglobal, --install-args-global, --applyargstodependencies, --apply-args-to-dependencies, --apply-install-arguments-to-dependencies
 Apply Install Arguments To Dependencies  - Should install arguments be 
   applied to dependent packages? Defaults to false.

 --paramsglobal, --params-global, --packageparametersglobal, --package-parameters-global, --applyparamstodependencies, --apply-params-to-dependencies, --apply-package-parameters-to-dependencies
 Apply Package Parameters To Dependencies  - Should package parameters be 
   applied to dependent packages? Defaults to false.

 --allowdowngrade, --allow-downgrade
 AllowDowngrade - Should an attempt at downgrading be allowed? Defaults 
   to false.

-m, --sxs, --sidebyside, --side-by-side, --allowmultiple, --allow-multiple, --allowmultipleversions, --allow-multiple-versions AllowMultipleVersions - Should multiple versions of a package be installed? Defaults to false.

-i, --ignoredependencies, --ignore-dependencies IgnoreDependencies - Ignore dependencies when upgrading package(s). Defaults to false.

-n, --skippowershell, --skip-powershell, --skipscripts, --skip-scripts, --skip-automation-scripts Skip PowerShell - Do not run chocolateyInstall.ps1. Defaults to false.

 --failonunfound, --fail-on-unfound
 Fail On Unfound Packages - If a package is not found in sources 
   specified, fail instead of warn.

 --ignore-unfound
 Ignore Unfound Packages - Ignore packages that are not found on the 
   sources used (or the defaults). Overrides the default feature 
   'ignoreUnfoundPackagesOnUpgradeOutdated' set to 'False'. Available in -
   0.10.9+.

 --failonnotinstalled, --fail-on-not-installed
 Fail On Non-installed Packages - If a package is not already installed, 
   fail instead of installing.

-u, --user=VALUE User - used with authenticated feeds. Defaults to empty.

-p, --password=VALUE Password - the user's password to the source. Defaults to empty.

 --cert=VALUE
 Client certificate - PFX pathname for an x509 authenticated feeds. 
   Defaults to empty. Available in 0.9.10+.

 --cp, --certpassword=VALUE
 Certificate Password - the client certificate's password to the source. 
   Defaults to empty. Available in 0.9.10+.

 --ignorechecksum, --ignore-checksum, --ignorechecksums, --ignore-checksums
 IgnoreChecksums - Ignore checksums provided by the package. Overrides 
   the default feature 'checksumFiles' set to 'True'. Available in 0.9.9.9+.

 --allowemptychecksum, --allowemptychecksums, --allow-empty-checksums
 Allow Empty Checksums - Allow packages to have empty/missing checksums 
   for downloaded resources from non-secure locations (HTTP, FTP). Use this 
   switch is not recommended if using sources that download resources from 
   the internet. Overrides the default feature 'allowEmptyChecksums' set to 
   'False'. Available in 0.10.0+.

 --allowemptychecksumsecure, --allowemptychecksumssecure, --allow-empty-checksums-secure
 Allow Empty Checksums Secure - Allow packages to have empty checksums 
   for downloaded resources from secure locations (HTTPS). Overrides the 
   default feature 'allowEmptyChecksumsSecure' set to 'True'. Available in 
   0.10.0+.

 --requirechecksum, --requirechecksums, --require-checksums
 Require Checksums - Requires packages to have checksums for downloaded 
   resources (both non-secure and secure). Overrides the default feature 
   'allowEmptyChecksums' set to 'False' and 'allowEmptyChecksumsSecure' set 
   to 'True'. Available in 0.10.0+.

 --checksum, --downloadchecksum, --download-checksum=VALUE
 Download Checksum - a user provided checksum for downloaded resources 
   for the package. Overrides the package checksum (if it has one).  
   Defaults to empty. Available in 0.10.0+.

 --checksum64, --checksumx64, --downloadchecksumx64, --download-checksum-x64=VALUE
 Download Checksum 64bit - a user provided checksum for 64bit downloaded 
   resources for the package. Overrides the package 64-bit checksum (if it 
   has one). Defaults to same as Download Checksum. Available in 0.10.0+.

 --checksumtype, --checksum-type, --downloadchecksumtype, --download-checksum-type=VALUE
 Download Checksum Type - a user provided checksum type. Overrides the 
   package checksum type (if it has one). Used in conjunction with Download 
   Checksum. Available values are 'md5', 'sha1', 'sha256' or 'sha512'. 
   Defaults to 'md5'. Available in 0.10.0+.

 --checksumtype64, --checksumtypex64, --checksum-type-x64, --downloadchecksumtypex64, --download-checksum-type-x64=VALUE
 Download Checksum Type 64bit - a user provided checksum for 64bit 
   downloaded resources for the package. Overrides the package 64-bit 
   checksum (if it has one). Used in conjunction with Download Checksum 
   64bit. Available values are 'md5', 'sha1', 'sha256' or 'sha512'. 
   Defaults to same as Download Checksum Type. Available in 0.10.0+.

 --ignorepackagecodes, --ignorepackageexitcodes, --ignore-package-codes, --ignore-package-exit-codes
 IgnorePackageExitCodes - Exit with a 0 for success and 1 for non-succes-
   s, no matter what package scripts provide for exit codes. Overrides the 
   default feature 'usePackageExitCodes' set to 'True'. Available in 0.-
   9.10+.

 --usepackagecodes, --usepackageexitcodes, --use-package-codes, --use-package-exit-codes
 UsePackageExitCodes - Package scripts can provide exit codes. Use those 
   for choco's exit code when non-zero (this value can come from a 
   dependency package). Chocolatey defines valid exit codes as 0, 1605, 
   1614, 1641, 3010. Overrides the default feature 'usePackageExitCodes' 
   set to 'True'. Available in 0.9.10+.

 --except=VALUE
 Except - a comma-separated list of package names that should not be 
   upgraded when upgrading 'all'. Overrides the configuration setting 
   'upgradeAllExceptions' set to ''. Available in 0.9.10+.

 --stoponfirstfailure, --stop-on-first-failure, --stop-on-first-package-failure
 Stop On First Package Failure - stop running install, upgrade or 
   uninstall on first package failure instead of continuing with others. 
   Overrides the default feature 'stopOnFirstPackageFailure' set to 'False-
   '. Available in 0.10.4+.

 --skip-if-not-installed, --only-upgrade-installed, --skip-when-not-installed
 Skip Packages Not Installed - if a package is not installed, do not 
   install it during the upgrade process. Overrides the default feature 
   'skipPackageUpgradesWhenNotInstalled' set to 'False'. Available in 0.1-
   0.12+.

 --install-if-not-installed
 Install Missing Packages When Not Installed - if a package is not 
   installed, install it as part of running upgrade (typically default 
   behavior). Overrides the default feature 
   'skipPackageUpgradesWhenNotInstalled' set to 'False'. Available in 0.1-
   0.12+.

 --exclude-pre, --exclude-prerelease, --exclude-prereleases
 Exclude Prerelease - Should prerelease be ignored for upgrades? Will be 
   ignored if you pass `--pre`. Available in 0.10.4+.

 --userememberedargs, --userememberedarguments, --userememberedoptions, --use-remembered-args, --use-remembered-arguments, --use-remembered-options
 Use Remembered Options for Upgrade - use the arguments and options used 
   during install for upgrade. Does not override arguments being passed at 
   runtime. Overrides the default feature 
   'useRememberedArgumentsForUpgrades' set to 'False'. Available in 0.10.4+.

 --ignorerememberedargs, --ignorerememberedarguments, --ignorerememberedoptions, --ignore-remembered-args, --ignore-remembered-arguments, --ignore-remembered-options
 Ignore Remembered Options for Upgrade - ignore the arguments and options 
   used during install for upgrade. Overrides the default feature 
   'useRememberedArgumentsForUpgrades' set to 'False'. Available in 0.10.4+.

 --exitwhenrebootdetected, --exit-when-reboot-detected
 Exit When Reboot Detected - Stop running install, upgrade, or uninstall 
   when a reboot request is detected. Requires 'usePackageExitCodes' 
   feature to be turned on. Will exit with either 350 or 1604. Overrides 
   the default feature 'exitOnRebootDetected' set to 'False'. Available in 
   0.10.12+.

 --ignoredetectedreboot, --ignore-detected-reboot
 Ignore Detected Reboot - Ignore any detected reboots if found. Overrides 
   the default feature 'exitOnRebootDetected' set to 'False'. Available in 
   0.10.12+.

 --disable-repository-optimizations, --disable-package-repository-optimizations
 Disable Package Repository Optimizations - Do not use optimizations for 
   reducing bandwidth with repository queries during package 
   install/upgrade/outdated operations. Should not generally be used, 
   unless a repository needs to support older methods of query. When 
   disabled, this makes queries similar to the way they were done in 
   Chocolatey v0.10.11 and before. Overrides the default feature 
   'usePackageRepositoryOptimizations' set to 'True'. Available in 0.10.14+.

 --sdc, --skipdownloadcache, --skip-download-cache
 Skip Download Cache - Use the original download even if a private CDN 
   cache is available for a package. Overrides the default feature 
   'downloadCache' set to 'True'. Available in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) 
   only. See https://docs.chocolatey.org/en-us/features/private-cdn 

 --dc, --downloadcache, --download-cache, --use-download-cache
 Use Download Cache - Use private CDN cache if available for a package. 
   Overrides the default feature 'downloadCache' set to 'True'. Available 
   in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only. See https://docs.chocolatey.org/en-
   us/features/private-cdn 

 --svc, --skipvirus, --skip-virus, --skipviruscheck, --skip-virus-check
 Skip Virus Check - Skip the virus check for downloaded files on this ru-
   n. Overrides the default feature 'virusCheck' set to 'False'. Available 
   in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only. See https://docs.chocolatey.org/en-
   us/features/virus-check 

 --virus, --viruscheck, --virus-check
 Virus Check - check downloaded files for viruses. Overrides the default 
   feature 'virusCheck' set to 'False'. Available in 0.9.10+. Licensed 
   editions only. See https://docs.chocolatey.org/en-us/features/virus-check 

 --viruspositivesmin, --virus-positives-minimum=VALUE
 Virus Check Minimum Scan Result Positives - the minimum number of scan 
   result positives required to flag a package. Used when virusScannerType 
   is VirusTotal. Overrides the default configuration value 
   'virusCheckMinimumPositives' set to '4'. Available in 0.9.10+. Licensed 
   editions only. See https://docs.chocolatey.org/en-us/features/virus-check 

 --install-arguments-sensitive=VALUE
 InstallArgumentsSensitive - Install Arguments to pass to the native 
   installer in the package that are sensitive and you do not want logged. 
   Defaults to unspecified. Available in 0.10.1+. [Licensed editions](https://chocolatey.org/compare) only.

 --package-parameters-sensitive=VALUE
 PackageParametersSensitive - Package Parameters to pass the package that 
   are sensitive and you do not want logged. Defaults to unspecified. 
   Available in 0.10.1+. [Licensed editions](https://chocolatey.org/compare) only.

 --dir, --directory, --installdir, --installdirectory, --install-dir, --install-directory=VALUE
 Install Directory Override - Override the default installation director-
   y. Chocolatey will automatically determine the type of installer and 
   pass the appropriate arguments to override the install directory. The 
   package must use Chocolatey install helpers and be installing an 
   installer for software. Available in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only. 
   See https://docs.chocolatey.org/en-us/features/install-directory-override 

 --bps, --maxdownloadrate, --max-download-rate, --maxdownloadbitspersecond, --max-download-bits-per-second, --maximumdownloadbitspersecond, --maximum-download-bits-per-second=VALUE
 Maximum Download Rate Bits Per Second - The maximum download rate in 
   bits per second. '0' or empty means no maximum. A number means that will 
   be the maximum download rate in bps. Defaults to config setting of '0'. 
   Available in [licensed editions](https://chocolatey.org/compare) v1.10+ only. See https://docs.chocolate-
   y.org/en-us/features/package-throttle  

 --reduce, --reduce-package-size, --deflate, --deflate-package-size
 Reducer Installed Package Size (Package Reducer) - Reduce size of the 
   nupkg file to very small and remove extracted archives and installers. 
   Overrides the default feature 'reduceInstalledPackageSpaceUsage' set to 
   'True'. [Licensed editions](https://chocolatey.org/compare) only (version 1.12.0+). See https://doc-
   s.chocolatey.org/en-us/features/package-reducer 

 --no-reduce, --no-reduce-package-size, --no-deflate, --no-deflate-package-size
 Do Not Reduce Installed Package Size - Leave the nupkg and files alone 
   in the package. Overrides the default feature 
   'reduceInstalledPackageSpaceUsage' set to 'True'. [Licensed editions](https://chocolatey.org/compare) only 
   (version 1.12.0+). See https://docs.chocolatey.org/en-
   us/features/package-reducer 

 --reduce-nupkg-only, --deflate-nupkg-only
 Reduce Only Nupkg File Size - reduce only the size of nupkg file when 
   using Package Reducer. Overrides the default feature 
   'reduceOnlyNupkgSize' set to 'False'. [Licensed editions](https://chocolatey.org/compare) only (version -
   1.12.0+). See https://docs.chocolatey.org/en-us/features/package-reducer 

 --exclude-chocolatey-packages-during-upgrade-all
 Exclude Chocolatey Packages During Upgrade All - When running the 'choco 
   upgrade all' command, do not upgrade any of the official Chocolatey 
   packages. Overrides the default feature 
   'excludeChocolateyPackagesDuringUpgradeAll' set to 'False'. Licensed 
   editions only (version 4.1.0+). 

 --include-chocolatey-packages-during-upgrade-all
 Include Chocolatey Package During Upgrade All - When running the 'choco 
   upgrade all' command, include all the official Chocolatey packages. 
   Overrides the default feature 
   'excludeChocolateyPackagesDuringUpgradeAll' set to 'False'. Licensed 
   editions only (version 4.1.0+).

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco upgrade -h.

=== --- Order: 10 xref: choco-command-config Title: Config Description: Config Command (choco config) RedirectFrom: - docs/commandsconfig

- docs/commands-config

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Config Command (choco config)

Chocolatey will allow you to interact with the configuration file settings.

:memo: NOTE Available in 0.9.9.9+.

Usage

choco config [list]|get|set|unset [<options/switches>]

:memo: NOTE Unset subcommand available in 0.9.10+.

Examples

choco config
choco config list
choco config get cacheLocation
choco config get --name cacheLocation
choco config set cacheLocation c:\temp\choco
choco config set --name cacheLocation --value c:\temp\choco
choco config unset proxy
choco config unset --name proxy

:memo: NOTE See scripting in how to pass arguments (choco -?) for how to write proper scripts and integrations.

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

If you find other exit codes that we have not yet documented, please file a ticket so we can document it at https://github.com/chocolatey/choco/issues/new/choose.

See It In Action

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

 --name=VALUE
 Name - the name of the config setting. Required with some actions. 
   Defaults to empty.

 --value=VALUE
 Value - the value of the config setting. Required with some actions. 
   Defaults to empty.

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco config -h.

=== --- Order: 200 xref: choco-command-unpackself Title: UnpackSelf Description: UnpackSelf Command (choco unpackself) RedirectFrom: - docs/commandsunpackself

- docs/commands-unpackself

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

UnpackSelf Command (choco unpackself)

This will unpack files needed by choco. It will overwrite existing files only if --force is specified.

:memo: NOTE This command should only be used when installing Chocolatey, not during normal operation.

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco unpackself -h.

=== --- Order: 160 xref: choco-command-support Title: Support Description: Support Command (choco support) RedirectFrom: - docs/commandssupport

- docs/commands-support

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Support Command (choco support)

As a licensed customer, you can reach out to our email for support. If you have phone support, you may reach out during the hours that are listed in your support contract. See https://chocolatey.org/support for details.

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~ -?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco support -h.

=== --- Order: 170 xref: choco-command-sync Title: Sync Description: Sync Command (choco sync) RedirectFrom: - docs/commandssync

- docs/commands-sync

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Synchronize Command (choco sync)

Business editions of Chocolatey starting at licensed version 1.9.0.

Synchronizes against the system installed software that are not installed as packages on Chocolatey. Searches through the system to see software that has been installed and generates packages from that software, baselines the packages against Chocolatey and makes the packages available to upload to source.

See https://docs.chocolatey.org/en-us/features/package-synchronization/

Usage

choco sync [<options/switches>]

Examples

choco sync
choco sync --id=putty
choco sync --id=putty --package-id=putty

See It In Action

Coming soon

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

downloading multiple packages, and you use --version=1.0.0, it is going to look for and try to download version 1.0.0 of every package

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

 --id=VALUE
 Id - The Display Name from Programs and Features

 --packageid, --package-id=VALUE
 PackageId - When used with Id, this will be the custom name for the 
   package. Business editions only (version 1.12.2+)

 --out, --outdir, --outputdirectory, --output-directory=VALUE
 OutputDirectory - Specifies the directory for the generated Chocolatey 
   package file(s). If not specified, uses a subdirectory of the current 
   directory.

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco sync -h.

=== --- Order: 100 xref: choco-command-outdated Title: Outdated Description: Outdated Command (choco outdated) RedirectFrom: - docs/commandsoutdated

- docs/commands-outdated

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Outdated Command (choco outdated)

Returns a list of outdated packages.

:memo: NOTE Available with 0.9.9.6+.

Usage

choco outdated [<options/switches>]

Examples

choco outdated
choco outdated -s https://somewhere/out/there
choco outdated -s "'https://somewhere/protected'" -u user -p pass

If you use --source=https://somewhere/out/there, it is going to look for outdated packages only based on that source, so you may want to add --ignore-unfound to your options.

:memo: NOTE See scripting in how to pass arguments (choco -?) for how to write proper scripts and integrations.

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

Enhanced: - 0: no outdated packages - -1 or 1: an error has occurred - 2: outdated packages have been found

:memo: NOTE Starting in v0.10.12, if you have the feature 'useEnhancedExitCodes' turned on, then choco will provide enhanced exit codes that allow better integration and scripting.

If you find other exit codes that we have not yet documented, please file a ticket so we can document it at https://github.com/chocolatey/choco/issues/new/choose.

See It In Action

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

-u, --user=VALUE User - used with authenticated feeds. Defaults to empty.

-p, --password=VALUE Password - the user's password to the source. Defaults to empty.

 --cert=VALUE
 Client certificate - PFX pathname for an x509 authenticated feeds. 
   Defaults to empty. Available in 0.9.10+.

 --cp, --certpassword=VALUE
 Certificate Password - the client certificate's password to the source. 
   Defaults to empty. Available in 0.9.10+.

 --pre, --prerelease
 Prerelease - Include Prereleases? Defaults to false. Available in 0.1-
   0.14+.

 --ignore-pinned
 Ignore Pinned - Ignore pinned packages. Defaults to false. Available in 
   0.10.6+.

 --ignore-unfound
 Ignore Unfound Packages - Ignore packages that are not found on the 
   sources used (or the defaults). Overrides the default feature 
   'ignoreUnfoundPackagesOnUpgradeOutdated' set to 'False'. Available in -
   0.10.9+.

 --disable-repository-optimizations, --disable-package-repository-optimizations
 Disable Package Repository Optimizations - Do not use optimizations for 
   reducing bandwidth with repository queries during package 
   install/upgrade/outdated operations. Should not generally be used, 
   unless a repository needs to support older methods of query. When 
   disabled, this makes queries similar to the way they were done in 
   Chocolatey v0.10.11 and before. Overrides the default feature 
   'usePackageRepositoryOptimizations' set to 'True'. Available in 0.10.14+.

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco outdated -h.

=== --- Order: 150 xref: choco-command-sources Title: Sources Description: Sources Command (choco sources) RedirectFrom: - docs/commandssources

- docs/commands-sources

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Source Command (choco sources)

Chocolatey will allow you to interact with sources.

:memo: NOTE Mostly compatible with older chocolatey client (0.9.8.x and below) with options and switches. When enabling, disabling or removing a source, use -name in front of the option now. In most cases you can still pass options and switches with one dash (-). For more details, see how to pass arguments (choco -?).

Usage

choco source [list]|add|remove|disable|enable [<options/switches>]
choco sources [list]|add|remove|disable|enable [<options/switches>]

Examples

choco source
choco source list
choco source add -n=bob -s="https://somewhere/out/there/api/v2/"
choco source add -n=bob -s "'https://somewhere/out/there/api/v2/'" -cert=\Users\bob\bob.pfx
choco source add -n=bob -s "'https://somewhere/out/there/api/v2/'" -u=bob -p=12345
choco source disable -n=bob
choco source enable -n=bob
choco source remove -n=bob

When it comes to the source location, this can be a folder/file share or an http location. If it is a url, it will be a location you can go to in a browser and it returns OData with something that says Packages in the browser, similar to what you see when you go to https://community.chocolatey.org/api/v2/.

:memo: NOTE See scripting in how to pass arguments (choco -?) for how to write proper scripts and integrations.

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

If you find other exit codes that we have not yet documented, please file a ticket so we can document it at https://github.com/chocolatey/choco/issues/new/choose.

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

-n, --name=VALUE Name - the name of the source. Required with actions other than list. Defaults to empty.

-s, --source=VALUE Source - The source. This can be a folder/file share or an http locatio- n. If it is a url, it will be a location you can go to in a browser and it returns OData with something that says Packages in the browser, similar to what you see when you go to https://community.chocolate- y.org/api/v2/. Required with add action. Defaults to empty.

-u, --user=VALUE User - used with authenticated feeds. Defaults to empty.

-p, --password=VALUE Password - the user's password to the source. Encrypted in chocolate- y.config file.

 --cert=VALUE
 Client certificate - PFX pathname for an x509 authenticated feeds. 
   Defaults to empty. Available in 0.9.10+.

 --cp, --certpassword=VALUE
 Certificate Password - the client certificate's password to the source. 
   Defaults to empty. Available in 0.9.10+.

 --priority=VALUE
 Priority - The priority order of this source as compared to other 
   sources, lower is better. Defaults to 0 (no priority). All priorities 
   above 0 will be evaluated first, then zero-based values will be 
   evaluated in config file order. Available in 0.9.9.9+.

 --bypassproxy, --bypass-proxy
 Bypass Proxy - Should this source explicitly bypass any explicitly or 
   system configured proxies? Defaults to false. Available in 0.10.4+.

 --allowselfservice, --allow-self-service
 Allow Self-Service - Should this source be allowed to be used with self-
   service? Requires business edition (v1.10.0+) with feature 
   'useBackgroundServiceWithSelfServiceSourcesOnly' turned on. Defaults to 
   false. Available in 0.10.4+.

 --adminonly, --admin-only
 Visible to Administrators Only - Should this source be visible to non-
   administrators? Requires business edition (v1.12.2+). Defaults to false. 
   Available in 0.10.8+.

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco sources -h.

=== --- Order: 90 xref: choco-command-optimize Title: Optimize Description: Optimize Command (choco optimize) RedirectFrom: - docs/commandsoptimize

- docs/commands-optimize

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Optimize Command (choco optimize)

Package Optimizer

Chocolatey Licensed editions starting at Chocolatey Licensed Extension v1.12.0.

Similar to Package Reducer, but reduces for existing packages. With Package Optimizer/Reducer:

nupkg file is reduced to 5KB or less, no matter the size.
zips / installers are automatically removed from the package directory if they are found.
zips / installers are removed from TEMP cache if found.

The following file extensions are removed automatically:

7z / zip / rar / gz / tar / sfx
iso
msi / msu / msp
exe files if they are detected to be an installer

Usage

choco optimize [<options/switches>]

Examples

choco optimize
choco optimize --reduce-nupkg-only

See It In Action

Coming soon

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

downloading multiple packages, and you use --version=1.0.0, it is going to look for and try to download version 1.0.0 of every package

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

 --reduce-nupkg-only, --deflate-nupkg-only
 Reduce Only Nupkg File Size - reduce only the size of nupkg file when 
   using Package Optimizer. [Licensed editions](https://chocolatey.org/compare) only (version 1.12.0+). 

 --id=VALUE
 Id - The package to optimize

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco optimize -h.

=== --- Order: 130 xref: choco-command-setapikey Title: SetApiKey Description: SetApiKey Command (choco setapikey) RedirectFrom: - docs/commandssetapikey

- docs/commands-setapikey

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

ApiKey Command (choco setapikey)

This lists api keys that are set or sets an api key for a particular source so it doesn't need to be specified every time.

Anything that doesn't contain source and key will list api keys.

Usage

choco apikey [<options/switches>]
choco setapikey [<options/switches>]

Examples

choco apikey
choco apikey -s https://somewhere/out/there
choco apikey -s="https://somewhere/out/there/" -k="value"
choco apikey -s "https://push.chocolatey.org/" -k="123-123123-123"
choco apikey -s "http://internal_nexus" -k="user:password"

For source location, this can be a folder/file share or an http location. When it comes to urls, they can be different from the packages url (where packages are searched and installed from). As an example, for Chocolatey's community package package repository, the package url is https://community.chocolatey.org/api/v2/, but the push url is https://push.chocolatey.org (and the deprecated https://chocolatey.org/ as a push url). Check the documentation for your choice of repository to learn what the push url is.

For the key, this can be an apikey that is provided by your source repository. With some sources, like Nexus, this can be a NuGet API key or it could be a user name and password specified as 'user:password' for the API key. Please see your repository's documentation (for Nexus, please see https://ch0.co/nexus2apikey).

:memo: NOTE See scripting in how to pass arguments (choco -?) for how to write proper scripts and integrations.

Connecting to Chocolatey.org (Community Package Repository)

In order to save your API key for https://push.chocolatey.org/, log in (or register, confirm and then log in) to https://push.chocolatey.org/, go to https://push.chocolatey.org/account, copy the API Key, and then use it in the following command:

choco apikey -k <your key here> -s https://push.chocolatey.org/

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

If you find other exit codes that we have not yet documented, please file a ticket so we can document it at https://github.com/chocolatey/choco/issues/new/choose.

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

-s, --source=VALUE Source [REQUIRED] - The source location for the key

-k, --key, --apikey, --api-key=VALUE ApiKey - The API key for the source. This is the authentication that identifies you and allows you to push to a source. With some sources this is either a key or it could be a user name and password specified as 'user:password'.

 --rem, --remove
 Removes an API key from Chocolatey

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco setapikey -h.

=== --- Order: 50 xref: choco-command-help Title: Help Description: Help Command (choco help) RedirectFrom: - docs/commandshelp

- docs/commands-help

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Help Command (choco help)

Displays the complete help information, including:

Available commands
How to pass options/switches
Scripting best practices and style guide

Usage

choco help

Examples

choco help

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

If you find other exit codes that we have not yet documented, please file a ticket so we can document it at https://github.com/chocolatey/choco/issues/new/choose.

Command Reference

--- Order: 110 xref: choco-command-pin Title: Pin Description: Pin Command (choco pin) RedirectFrom: - docs/commandspin

- docs/commands-pin

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Pin Command (choco pin)

Pin a package to suppress upgrades.

This is especially helpful when running choco upgrade for all packages, as it will automatically skip those packages. Another alternative is choco upgrade --except="pkg1,pk2".

Usage

choco pin [list]|add|remove [<options/switches>]

Examples

choco pin
choco pin list
choco pin add -n git
choco pin add --name="'git'" --version="'1.2.3'"
choco pin add --name="'git'" --version="'1.2.3'" --reason="'reasons available in business editions only'"
choco pin remove --name="'git'"

:memo: NOTE See scripting in how to pass arguments (choco -?) for how to write proper scripts and integrations.

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

If you find other exit codes that we have not yet documented, please file a ticket so we can document it at https://github.com/chocolatey/choco/issues/new/choose.

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

-n, --name=VALUE Name - the name of the package. Required with some actions. Defaults to empty.

 --version=VALUE
 Version - Used when multiple versions of a package are installed.  
   Defaults to empty.

 --reason, --pin-reason, --note=VALUE
 Pin Reason - Text information about why you are setting a pin. Available 
   in business editions 1.12.2+.

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco pin -h.

=== --- Order: 70 xref: choco-command-install Title: Install Description: Install Command (choco install) RedirectFrom: - docs/commandsinstall

- docs/commands-install

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Install Command (choco install)

Installs a package or a list of packages (sometimes specified as a packages.config).

:memo: NOTE 100% compatible with older chocolatey client (0.9.8.32 and below) with options and switches. Add -y for previous behavior with no prompt. In most cases you can still pass options and switches with one dash (-). For more details, see how to pass arguments (choco -?).

DEPRECATION NOTICE

Starting in v2.0.0 the shortcut cinst will be removed and can not be used to install packages anymore. We recommend you make sure that you always use the full command going forward (choco install).

Usage

choco install <pkg|packages.config> [<pkg2> <pkgN>] [<options/switches>]
cinst <pkg|packages.config> [<pkg2> <pkgN>] [<options/switches>] (DEPRECATED, will be removed in v2.0.0)

:memo: NOTE all is a special package keyword that will allow you to install all packages from a custom feed. Will not work with Chocolatey default feed. THIS IS NOT YET REIMPLEMENTED.

:memo: NOTE Any package name ending with .config is considered a 'packages.config' file. Please see https://ch0.co/packages_config

:memo: NOTE Chocolatey Pro / Business builds on top of a great open source experience with quite a few features that enhance the your use of the community package repository (when using Pro), and really enhance the Chocolatey experience all around. If you are an organization looking for a better ROI, look no further than Business - automatic package creation from installer files, automatic recompile support, runtime malware protection, private CDN download cache, synchronize with Programs and Features, etc - https://chocolatey.org/compare.

Examples

choco install sysinternals
choco install notepadplusplus googlechrome atom 7zip
choco install notepadplusplus --force --force-dependencies
choco install notepadplusplus googlechrome atom 7zip -dvfy
choco install git -y --params="'/GitAndUnixToolsOnPath /NoAutoCrlf'"
choco install git -y --params="'/GitAndUnixToolsOnPath /NoAutoCrlf'" --install-arguments="'/DIR=C:\git'"
# Params are package parameters, passed to the package
# Install args are installer arguments, appended to the silentArgs
#  in the package for the installer itself
choco install nodejs.install --version 0.10.35
choco install git -s "'https://somewhere/out/there'"
choco install git -s "'https://somewhere/protected'" -u user -p pass

Choco can also install directly from a nuspec/nupkg file. This aids in testing packages:

choco install <path/to/nuspec>
choco install <path/to/nupkg>

Install multiple versions of a package using -m (AllowMultiple versions)

choco install ruby --version 1.9.3.55100 -my
choco install ruby --version 2.0.0.59800 -my
choco install ruby --version 2.1.5 -my

What is -my? See option bundling in how to pass arguments (choco -?).

:memo: NOTE All of these will add to PATH variable. We'll be adding a special option to not allow PATH changes. Until then you will need to manually go modify Path to just one Ruby and then use something like uru (https://bitbucket.org/jonforums/uru) or pik (https://community.chocolatey.org/packages/pik) to switch between versions.

:memo: NOTE See scripting in how to pass arguments (choco -?) for how to write proper scripts and integrations.

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

Package Exit Codes: - 1641: success, reboot initiated - 3010: success, reboot required - other (not listed): likely an error has occurred

Reboot Exit Codes: - 350: pending reboot detected, no action has occurred - 1604: install suspended, incomplete

See It In Action

Chocolatey FOSS install showing tab completion and refreshenv (a way to update environment variables without restarting the shell).

Chocolatey Professional showing private download cache and virus scan protection.

Packages.config

Alternative to PackageName. This is a list of packages in an xml manifest for Chocolatey to install. This is like the packages.config that NuGet uses except it also adds other options and switches. This can also be the path to the packages.config file if it is not in the current working directory.

:memo: NOTE The filename is only required to end in .config, the name is not required to be packages.config.

~~~xml <?xml version="1.0" encoding="utf-8"?> ~~~

Alternative Sources

Available in 0.9.10+.

Ruby

This specifies the source is Ruby Gems and that we are installing a gem. If you do not have ruby installed prior to running this command, the command will install that first. e.g. choco install compass -source ruby

WebPI

This specifies the source is Web PI (Web Platform Installer) and that we are installing a WebPI product, such as IISExpress. If you do not have the Web PI command line installed, it will install that first and then the product requested. e.g. choco install IISExpress --source webpi

Cygwin

This specifies the source is Cygwin and that we are installing a cygwin package, such as bash. If you do not have Cygwin installed, it will install that first and then the product requested. e.g. choco install bash --source cygwin

Python

This specifies the source is Python and that we are installing a python package, such as Sphinx. If you do not have easy_install and Python installed, it will install those first and then the product requested. e.g. choco install sphinx --source python

Windows Features

This specifies that the source is a Windows Feature and we should install via the Deployment Image Servicing and Management tool (DISM) on the local machine. e.g. choco install IIS-WebServerRole --source windowsfeatures

Resources

How-To: A complete example of how you can use the PackageParameters argument when creating a Chocolatey Package can be seen at https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument
One may want to override the default installation directory of a piece of software. See https://docs.chocolatey.org/en-us/getting-started#overriding-default-install-directory-or-other-advanced-install-concepts.

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

 --version=VALUE
 Version - A specific version to install. Defaults to unspecified.

 --pre, --prerelease
 Prerelease - Include Prereleases? Defaults to false.

 --x86, --forcex86
 ForceX86 - Force x86 (32bit) installation on 64 bit systems. Defaults to 
   false.

 --ia, --installargs, --install-args, --installarguments, --install-arguments=VALUE
 InstallArguments - Install Arguments to pass to the native installer in 
   the package. Defaults to unspecified.

 --notsilent, --not-silent
 NotSilent - Do not install this silently. Defaults to false.

 --params, --parameters, --pkgparameters, --packageparameters, --package-parameters=VALUE
 PackageParameters - Parameters to pass to the package. Defaults to 
   unspecified.

 --argsglobal, --args-global, --installargsglobal, --install-args-global, --applyargstodependencies, --apply-args-to-dependencies, --apply-install-arguments-to-dependencies
 Apply Install Arguments To Dependencies  - Should install arguments be 
   applied to dependent packages? Defaults to false.

 --paramsglobal, --params-global, --packageparametersglobal, --package-parameters-global, --applyparamstodependencies, --apply-params-to-dependencies, --apply-package-parameters-to-dependencies
 Apply Package Parameters To Dependencies  - Should package parameters be 
   applied to dependent packages? Defaults to false.

 --allowdowngrade, --allow-downgrade
 AllowDowngrade - Should an attempt at downgrading be allowed? Defaults 
   to false.

-i, --ignoredependencies, --ignore-dependencies IgnoreDependencies - Ignore dependencies when installing package(s). Defaults to false.

-x, --forcedependencies, --force-dependencies ForceDependencies - Force dependencies to be reinstalled when force installing package(s). Must be used in conjunction with --force. Defaults to false.

-n, --skippowershell, --skip-powershell, --skipscripts, --skip-scripts, --skip-automation-scripts Skip PowerShell - Do not run chocolateyInstall.ps1. Defaults to false.

-u, --user=VALUE User - used with authenticated feeds. Defaults to empty.

-p, --password=VALUE Password - the user's password to the source. Defaults to empty.

 --cert=VALUE
 Client certificate - PFX pathname for an x509 authenticated feeds. 
   Defaults to empty. Available in 0.9.10+.

 --cp, --certpassword=VALUE
 Certificate Password - the client certificate's password to the source. 
   Defaults to empty. Available in 0.9.10+.

 --ignorechecksum, --ignore-checksum, --ignorechecksums, --ignore-checksums
 IgnoreChecksums - Ignore checksums provided by the package. Overrides 
   the default feature 'checksumFiles' set to 'True'. Available in 0.9.9.9+.

 --allowemptychecksum, --allowemptychecksums, --allow-empty-checksums
 Allow Empty Checksums - Allow packages to have empty/missing checksums 
   for downloaded resources from non-secure locations (HTTP, FTP). Use this 
   switch is not recommended if using sources that download resources from 
   the internet. Overrides the default feature 'allowEmptyChecksums' set to 
   'False'. Available in 0.10.0+.

 --allowemptychecksumsecure, --allowemptychecksumssecure, --allow-empty-checksums-secure
 Allow Empty Checksums Secure - Allow packages to have empty checksums 
   for downloaded resources from secure locations (HTTPS). Overrides the 
   default feature 'allowEmptyChecksumsSecure' set to 'True'. Available in 
   0.10.0+.

 --requirechecksum, --requirechecksums, --require-checksums
 Require Checksums - Requires packages to have checksums for downloaded 
   resources (both non-secure and secure). Overrides the default feature 
   'allowEmptyChecksums' set to 'False' and 'allowEmptyChecksumsSecure' set 
   to 'True'. Available in 0.10.0+.

 --checksum, --downloadchecksum, --download-checksum=VALUE
 Download Checksum - a user provided checksum for downloaded resources 
   for the package. Overrides the package checksum (if it has one).  
   Defaults to empty. Available in 0.10.0+.

 --checksum64, --checksumx64, --downloadchecksumx64, --download-checksum-x64=VALUE
 Download Checksum 64bit - a user provided checksum for 64bit downloaded 
   resources for the package. Overrides the package 64-bit checksum (if it 
   has one). Defaults to same as Download Checksum. Available in 0.10.0+.

 --checksumtype, --checksum-type, --downloadchecksumtype, --download-checksum-type=VALUE
 Download Checksum Type - a user provided checksum type. Overrides the 
   package checksum type (if it has one). Used in conjunction with Download 
   Checksum. Available values are 'md5', 'sha1', 'sha256' or 'sha512'. 
   Defaults to 'md5'. Available in 0.10.0+.

 --checksumtype64, --checksumtypex64, --checksum-type-x64, --downloadchecksumtypex64, --download-checksum-type-x64=VALUE
 Download Checksum Type 64bit - a user provided checksum for 64bit 
   downloaded resources for the package. Overrides the package 64-bit 
   checksum (if it has one). Used in conjunction with Download Checksum 
   64bit. Available values are 'md5', 'sha1', 'sha256' or 'sha512'. 
   Defaults to same as Download Checksum Type. Available in 0.10.0+.

 --ignorepackagecodes, --ignorepackageexitcodes, --ignore-package-codes, --ignore-package-exit-codes
 IgnorePackageExitCodes - Exit with a 0 for success and 1 for non-succes-
   s, no matter what package scripts provide for exit codes. Overrides the 
   default feature 'usePackageExitCodes' set to 'True'. Available in 0.-
   9.10+.

 --usepackagecodes, --usepackageexitcodes, --use-package-codes, --use-package-exit-codes
 UsePackageExitCodes - Package scripts can provide exit codes. Use those 
   for choco's exit code when non-zero (this value can come from a 
   dependency package). Chocolatey defines valid exit codes as 0, 1605, 
   1614, 1641, 3010.  Overrides the default feature 'usePackageExitCodes' 
   set to 'True'. Available in 0.9.10+.

 --stoponfirstfailure, --stop-on-first-failure, --stop-on-first-package-failure
 Stop On First Package Failure - stop running install, upgrade or 
   uninstall on first package failure instead of continuing with others. 
   Overrides the default feature 'stopOnFirstPackageFailure' set to 'False-
   '. Available in 0.10.4+.

 --exitwhenrebootdetected, --exit-when-reboot-detected
 Exit When Reboot Detected - Stop running install, upgrade, or uninstall 
   when a reboot request is detected. Requires 'usePackageExitCodes' 
   feature to be turned on. Will exit with either 350 or 1604. Overrides 
   the default feature 'exitOnRebootDetected' set to 'False'. Available in 
   0.10.12+.

 --ignoredetectedreboot, --ignore-detected-reboot
 Ignore Detected Reboot - Ignore any detected reboots if found. Overrides 
   the default feature 'exitOnRebootDetected' set to 'False'. Available in 
   0.10.12+.

 --disable-repository-optimizations, --disable-package-repository-optimizations
 Disable Package Repository Optimizations - Do not use optimizations for 
   reducing bandwidth with repository queries during package 
   install/upgrade/outdated operations. Should not generally be used, 
   unless a repository needs to support older methods of query. When used, 
   this makes queries similar to the way they were done in Chocolatey v0.1-
   0.11 and before. Overrides the default feature 
   'usePackageRepositoryOptimizations' set to 'True'. Available in 0.10.14+.

 --sdc, --skipdownloadcache, --skip-download-cache
 Skip Download Cache - Use the original download even if a private CDN 
   cache is available for a package. Overrides the default feature 
   'downloadCache' set to 'True'. Available in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) 
   only. See https://docs.chocolatey.org/en-us/features/private-cdn 

 --dc, --downloadcache, --download-cache, --use-download-cache
 Use Download Cache - Use private CDN cache if available for a package. 
   Overrides the default feature 'downloadCache' set to 'True'. Available 
   in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only. See https://docs.chocolatey.org/en-
   us/features/private-cdn 

 --svc, --skipvirus, --skip-virus, --skipviruscheck, --skip-virus-check
 Skip Virus Check - Skip the virus check for downloaded files on this ru-
   n. Overrides the default feature 'virusCheck' set to 'False'. Available 
   in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only. See https://docs.chocolatey.org/en-
   us/features/virus-check 

 --virus, --viruscheck, --virus-check
 Virus Check - check downloaded files for viruses. Overrides the default 
   feature 'virusCheck' set to 'False'. Available in 0.9.10+. Licensed 
   editions only. See https://docs.chocolatey.org/en-us/features/virus-check 

 --viruspositivesmin, --virus-positives-minimum=VALUE
 Virus Check Minimum Scan Result Positives - the minimum number of scan 
   result positives required to flag a package. Used when virusScannerType 
   is VirusTotal. Overrides the default configuration value 
   'virusCheckMinimumPositives' set to '4'. Available in 0.9.10+. Licensed 
   editions only. See https://docs.chocolatey.org/en-us/features/virus-
   check 

 --install-arguments-sensitive=VALUE
 InstallArgumentsSensitive - Install Arguments to pass to the native 
   installer in the package that are sensitive and you do not want logged. 
   Defaults to unspecified. Available in 0.10.1+. [Licensed editions](https://chocolatey.org/compare) only.

 --package-parameters-sensitive=VALUE
 PackageParametersSensitive - Package Parameters to pass the package that 
   are sensitive and you do not want logged. Defaults to unspecified. 
   Available in 0.10.1+. [Licensed editions](https://chocolatey.org/compare) only.

 --dir, --directory, --installdir, --installdirectory, --install-dir, --install-directory=VALUE
 Install Directory Override - Override the default installation director-
   y. Chocolatey will automatically determine the type of installer and 
   pass the appropriate arguments to override the install directory. The 
   package must use Chocolatey install helpers and be installing an 
   installer for software. Available in 0.9.10+. [Licensed editions](https://chocolatey.org/compare) only. 
   See https://docs.chocolatey.org/en-us/features/install-directory-override 

 --bps, --maxdownloadrate, --max-download-rate, --maxdownloadbitspersecond, --max-download-bits-per-second, --maximumdownloadbitspersecond, --maximum-download-bits-per-second=VALUE
 Maximum Download Rate Bits Per Second - The maximum download rate in 
   bits per second. '0' or empty means no maximum. A number means that will 
   be the maximum download rate in bps. Defaults to config setting of '0'. 
   Available in [licensed editions](https://chocolatey.org/compare) v1.10+ only. See https://docs.chocolate-
   y.org/en-us/features/package-throttle  

 --reduce, --reduce-package-size, --deflate, --deflate-package-size
 Reducer Installed Package Size (Package Reducer) - Reduce size of the 
   nupkg file to very small and remove extracted archives and installers. 
   Overrides the default feature 'reduceInstalledPackageSpaceUsage' set to 
   'True'. [Licensed editions](https://chocolatey.org/compare) only (version 1.12.0+). See https://doc-
   s.chocolatey.org/en-us/features/package-reducer 

 --no-reduce, --no-reduce-package-size, --no-deflate, --no-deflate-package-size
 Do Not Reduce Installed Package Size - Leave the nupkg and files alone 
   in the package. Overrides the default feature 
   'reduceInstalledPackageSpaceUsage' set to 'True'. [Licensed editions](https://chocolatey.org/compare) only 
   (version 1.12.0+). See https://docs.chocolatey.org/en-
   us/features/package-reducer 

 --reduce-nupkg-only, --deflate-nupkg-only
 Reduce Only Nupkg File Size - reduce only the size of nupkg file when 
   using Package Reducer. Overrides the default feature 
   'reduceOnlyNupkgSize' set to 'False'. [Licensed editions](https://chocolatey.org/compare) only (version -
   1.12.0+). See https://docs.chocolatey.org/en-us/features/package-reducer

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco install -h.

=== --- Order: 190 xref: choco-command-uninstall Title: Uninstall Description: Uninstall Command (choco uninstall) RedirectFrom: - docs/commandsuninstall

- docs/commands-uninstall

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Uninstall Command (choco uninstall)

Uninstalls a package or a list of packages.

:memo: NOTE 100% compatible with older chocolatey client (0.9.8.32 and below) with options and switches. Add -y for previous behavior with no prompt. In most cases you can still pass options and switches with one dash (-). For more details, see how to pass arguments (choco -?).

Choco 0.9.9+ automatically tracks registry changes for "Programs and Features" of the underlying software's native installers when installing packages. The "Automatic Uninstaller" (auto uninstaller) service is a feature that can use that information to automatically determine how to uninstall these natively installed applications. This means that a package may not need an explicit chocolateyUninstall.ps1 to reverse the installation done in the install script.

Chocolatey tracks packages, which are the files in $env:ChocolateyInstall\lib\packagename. These packages may or may not contain the software (applications/tools) that each package represents. The software may actually be installed in Program Files (most native installers will install the software there) or elsewhere on the machine.

With auto uninstaller turned off, a chocolateyUninstall.ps1 is required to perform uninstall from the system. In the absence of chocolateyUninstall.ps1, choco uninstall only removes the package from Chocolatey but does not remove the software from your system (unless in the package directory).

:memo: NOTE A package with a failing uninstall can be removed with the -n --skipautouninstaller flags. This will remove the package from chocolatey without attempting to uninstall the program.

:memo: NOTE Starting in 0.9.10+, the Automatic Uninstaller (AutoUninstaller) is turned on by default. To turn it off, run the following command:

choco feature disable -n autoUninstaller

:memo: NOTE Chocolatey Pro / Business automatically synchronizes with Programs and Features, ensuring manually removed apps are automatically removed from Chocolatey's repository.

:memo: NOTE Synchronizer and AutoUninstaller enhancements in licensed versions of Chocolatey ensure that Autouninstaller is up to 95% effective at removing software without an uninstall script. This is because synchronizer ensures the registry snapshot stays up to date and licensed enhancements have the ability to inspect more locations to determine how to automatically uninstall software.

DEPRECATION NOTICE

Starting in v2.0.0 the shortcut cuninst will be removed and can not be used to uninstall packages anymore. We recommend you make sure that you always use the full command going forward (choco uninstall).

Usage

choco uninstall <pkg|all> [pkg2 pkgN] [options/switches]
cuninst <pkg|all> [pkg2 pkgN] [options/switches] (DEPRECATED, will be removed in v2.0.0)

:memo: NOTE all is a special package keyword that will allow you to uninstall all packages.

See It In Action

Examples

choco uninstall git
choco uninstall notepadplusplus googlechrome atom 7zip
choco uninstall notepadplusplus googlechrome atom 7zip -dv
choco uninstall ruby --version 1.8.7.37402
choco uninstall nodejs.install --all-versions

:memo: NOTE See scripting in how to pass arguments (choco -?) for how to write proper scripts and integrations.

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

Package Exit Codes: - 1605: software is not installed - 1614: product is uninstalled - 1641: success, reboot initiated - 3010: success, reboot required - other (not listed): likely an error has occurred

In addition to normal exit codes, packages are allowed to exit with their own codes when the feature 'usePackageExitCodes' is turned on. Available in v0.9.10+.

Reboot Exit Codes: - 350: pending reboot detected, no action has occurred - 1604: install suspended, incomplete

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

-s, --source=VALUE Source - The source to find the package(s) to install. Special sources include: ruby, webpi, cygwin, windowsfeatures, and python. Defaults to default feeds.

 --version=VALUE
 Version - A specific version to uninstall. Defaults to unspecified.

-a, --allversions, --all-versions AllVersions - Uninstall all versions? Defaults to false.

 --ua, --uninstallargs, --uninstallarguments, --uninstall-arguments=VALUE
 UninstallArguments - Uninstall Arguments to pass to the native installer 
   in the package. Defaults to unspecified.

-o, --override, --overrideargs, --overridearguments, --override-arguments OverrideArguments - Should uninstall arguments be used exclusively without appending to current package passed arguments? Defaults to false.

 --notsilent, --not-silent
 NotSilent - Do not uninstall this silently. Defaults to false.

 --params, --parameters, --pkgparameters, --packageparameters, --package-parameters=VALUE
 PackageParameters - Parameters to pass to the package. Defaults to 
   unspecified.

 --argsglobal, --args-global, --installargsglobal, --install-args-global, --applyargstodependencies, --apply-args-to-dependencies, --apply-install-arguments-to-dependencies
 Apply Install Arguments To Dependencies  - Should install arguments be 
   applied to dependent packages? Defaults to false.

 --paramsglobal, --params-global, --packageparametersglobal, --package-parameters-global, --applyparamstodependencies, --apply-params-to-dependencies, --apply-package-parameters-to-dependencies
 Apply Package Parameters To Dependencies  - Should package parameters be 
   applied to dependent packages? Defaults to false.

-x, --forcedependencies, --force-dependencies, --removedependencies, --remove-dependencies RemoveDependencies - Uninstall dependencies when uninstalling package(s- ). Defaults to false.

-n, --skippowershell, --skip-powershell, --skipscripts, --skip-scripts, --skip-automation-scripts Skip PowerShell - Do not run chocolateyUninstall.ps1. Defaults to false.

 --ignorepackagecodes, --ignorepackageexitcodes, --ignore-package-codes, --ignore-package-exit-codes
 IgnorePackageExitCodes - Exit with a 0 for success and 1 for non-succes-
   s, no matter what package scripts provide for exit codes. Overrides the 
   default feature 'usePackageExitCodes' set to 'True'. Available in 0.-
   9.10+.

 --usepackagecodes, --usepackageexitcodes, --use-package-codes, --use-package-exit-codes
 UsePackageExitCodes - Package scripts can provide exit codes. Use those 
   for choco's exit code when non-zero (this value can come from a 
   dependency package). Chocolatey defines valid exit codes as 0, 1605, 
   1614, 1641, 3010. Overrides the default feature 'usePackageExitCodes' 
   set to 'True'. Available in 0.9.10+.

 --autouninstaller, --use-autouninstaller
 UseAutoUninstaller - Use auto uninstaller service when uninstalling. 
   Overrides the default feature 'autoUninstaller' set to 'True'. Available 
   in 0.9.10+.

 --skipautouninstaller, --skip-autouninstaller
 SkipAutoUninstaller - Skip auto uninstaller service when uninstalling. 
   Overrides the default feature 'autoUninstaller' set to 'True'. Available 
   in 0.9.10+.

 --failonautouninstaller, --fail-on-autouninstaller
 FailOnAutoUninstaller - Fail the package uninstall if the auto 
   uninstaller reports and error. Overrides the default feature 
   'failOnAutoUninstaller' set to 'False'. Available in 0.9.10+.

 --ignoreautouninstallerfailure, --ignore-autouninstaller-failure
 Ignore Auto Uninstaller Failure - Do not fail the package if auto 
   uninstaller reports an error. Overrides the default feature 
   'failOnAutoUninstaller' set to 'False'. Available in 0.9.10+.

 --stoponfirstfailure, --stop-on-first-failure, --stop-on-first-package-failure
 Stop On First Package Failure - stop running install, upgrade or 
   uninstall on first package failure instead of continuing with others. 
   Overrides the default feature 'stopOnFirstPackageFailure' set to 'False-
   '. Available in 0.10.4+.

 --exitwhenrebootdetected, --exit-when-reboot-detected
 Exit When Reboot Detected - Stop running install, upgrade, or uninstall 
   when a reboot request is detected. Requires 'usePackageExitCodes' 
   feature to be turned on. Will exit with either 350 or 1604.  Overrides 
   the default feature 'exitOnRebootDetected' set to 'False'.  Available in 
   0.10.12+.

 --ignoredetectedreboot, --ignore-detected-reboot
 Ignore Detected Reboot - Ignore any detected reboots if found. Overrides 
   the default feature 'exitOnRebootDetected' set to 'False'.  Available in 
   0.10.12+.

 --fromprograms, --from-programs, --fromprogramsandfeatures, --from-programs-and-features
 From Programs and Features - Uninstalls a program from programs and 
   features. Name used for id must be a match or a wildcard (*) to Display 
   Name in Programs and Features. Available in [licensed editions](https://chocolatey.org/compare) only 
   (licensed version 1.8.0+) and requires v0.10.4+.

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco uninstall -h.

=== --- Order: 180 xref: choco-command-synchronize Title: Synchronize Description: Synchronize Command (choco synchronize) RedirectFrom: - docs/commandssynchronize

- docs/commands-synchronize

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Synchronize Command (choco synchronize)

Business editions of Chocolatey starting at licensed version 1.9.0.

See https://docs.chocolatey.org/en-us/features/package-synchronization/

Usage

choco sync [<options/switches>]

Examples

choco sync
choco sync --id=putty
choco sync --id=putty --package-id=putty

See It In Action

Coming soon

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

downloading multiple packages, and you use --version=1.0.0, it is going to look for and try to download version 1.0.0 of every package

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

 --id=VALUE
 Id - The Display Name from Programs and Features

 --packageid, --package-id=VALUE
 PackageId - When used with Id, this will be the custom name for the 
   package. Business editions only (version 1.12.2+)

 --out, --outdir, --outputdirectory, --output-directory=VALUE
 OutputDirectory - Specifies the directory for the generated Chocolatey 
   package file(s). If not specified, uses a subdirectory of the current 
   directory.

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco synchronize -h.

=== --- Order: 120 xref: choco-command-search Title: Search Description: Search Command (choco search) RedirectFrom: - docs/commandssearch

- docs/commands-search

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

List/Search Command (choco search)

Chocolatey will perform a search for a package local or remote.

:memo: NOTE 100% compatible with older Chocolatey client (0.9.8.x and below) with options and switches. In most cases you can still pass options and switches with one dash (-). For more details, see how to pass arguments (choco -?).

Usage

choco find <filter> [<options/switches>]
choco list <filter> [<options/switches>]
choco search <filter> [<options/switches>]
clist <filter> [<options/switches>] (DEPRECATED, will be removed in v2.0.0)

Examples

choco list --local-only (DEPRECATED: will be default for list in v2.0.0)
choco list -li
choco list -lai
choco list --page=0 --page-size=25
choco search git
choco search git --source="'https://somewhere/out/there'"
choco search bob -s "'https://somewhere/protected'" -u user -p pass

:memo: NOTE See scripting in how to pass arguments (choco -?) for how to write proper scripts and integrations.

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

Enhanced: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred - 2: no results (enhanced)

:memo: NOTE Starting in v0.10.12, if you have the feature 'useEnhancedExitCodes' turned on, then choco will provide enhanced exit codes that allow better integration and scripting.

If you find other exit codes that we have not yet documented, please file a ticket so we can document it at https://github.com/chocolatey/choco/issues/new/choose.

See It In Action

Alternative Sources

Available in 0.9.10+.

WebPI

Windows Features

This specifies that the source is a Windows Feature and we should install via the Deployment Image Servicing and Management tool (DISM) on the local machine. e.g. choco search --source windowsfeatures

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

-s, --source=VALUE Source - Source location for install. Can use special 'webpi' or 'windowsfeatures' sources. Defaults to sources.

-l, --lo, --local, --localonly, --local-only LocalOnly - Only search against local machine items. Ignores --source if provided..

 --idonly, --id-only
 Id Only - Only return Package Ids in the list results. Available in 0.1-
   0.6+.

 --pre, --prerelease
 Prerelease - Include Prereleases? Defaults to false.

-i, --includeprograms, --include-programs IncludePrograms - Used in conjunction with LocalOnly, filters out apps chocolatey has listed as packages and includes those in the list. Defaults to false.

-a, --all, --allversions, --all-versions AllVersions - include results from all versions.

 --version=VALUE
 Version - Specific version of a package to return.

-u, --user=VALUE User - used with authenticated feeds. Defaults to empty.

-p, --password=VALUE Password - the user's password to the source. Defaults to empty.

 --cert=VALUE
 Client certificate - PFX pathname for an x509 authenticated feeds. 
   Defaults to empty. Available in 0.9.10+.

 --cp, --certpassword=VALUE
 Certificate Password - the client certificate's password to the source. 
   Defaults to empty. Available in 0.9.10+.

 --page=VALUE
 Page - the 'page' of results to return. Defaults to return all results. 
   Available in 0.9.10+.

 --page-size=VALUE
 Page Size - the amount of package results to return per page. Defaults 
   to 25. Available in 0.9.10+.

-e, --exact Exact - Only return packages with this exact name. Available in 0.9.10+.

 --by-id-only
 ByIdOnly - Only return packages where the id contains the search filter. 
   Available in 0.9.10+.

 --by-tag-only, --by-tags-only
 ByTagOnly - Only return packages where the search filter matches on the 
   tags. Available in 0.10.6+.

 --id-starts-with
 IdStartsWith - Only return packages where the id starts with the search 
   filter. Available in 0.9.10+.

 --order-by-popularity
 OrderByPopularity - Sort by package results by popularity. Available in 
   0.9.10+.

 --approved-only
 ApprovedOnly - Only return approved packages - this option will filter 
   out results not from the [community repository](https://community.chocolatey.org/packages). Available in 0.9.10+.

 --download-cache, --download-cache-only
 DownloadCacheAvailable - Only return packages that have a download cache 
   available - this option will filter out results not from the community 
   repository. Available in 0.9.10+.

 --not-broken
 NotBroken - Only return packages that are not failing testing - this 
   option only filters out failing results from the [community feed](https://community.chocolatey.org/packages). It will 
   not filter against other sources. Available in 0.9.10+.

 --detail, --detailed
 Detailed - Alias for verbose. Available in 0.9.10+.

 --disable-repository-optimizations, --disable-package-repository-optimizations
 Disable Package Repository Optimizations - Do not use optimizations for 
   reducing bandwidth with repository queries during package 
   install/upgrade/outdated operations. Should not generally be used, 
   unless a repository needs to support older methods of query. When 
   disabled, this makes queries similar to the way they were done in 
   Chocolatey v0.10.11 and before. Overrides the default feature 
   'usePackageRepositoryOptimizations' set to 'True'. Available in 0.10.14+.

 --audit, --showaudit, --show-audit, --show-audit-info
 Show Audit Information - Display auditing information for a package. 
   Available in business editions 1.12.0+.

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco search -h.

=== --- Order: 20 xref: choco-command-download Title: Download Description: Download Command (choco download) RedirectFrom: - docs/commandsdownload

- docs/commands-download

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Download Command (choco download)

Package Copy / Package Downloader

Chocolatey Professional and up (Pro+) starting in version 1.7.1.

Downloads a package from a source and unpacks it.

Package Internalizer

Chocolatey for Business (C4B) starting at licensed version 1.5.0. Chocolatey for Managed Service Providers (MSP) starting in 1.12.1.

Downloads a package from a source, optionally downloading remote resources and recompiling the package to use internal resources. This takes an existing package and makes it available without any internet requirement.

See https://docs.chocolatey.org/en-us/features/package-internalizer

Usage

choco download <pkg> [<options/switches>] [install_script_variable=value]

Install script variables are values that are discovered in the
 chocolateyInstall.ps1 (or a script it calls). When you find values
 there maybe don't get found and replaced or they use a default
 value and you want to provide a value for them to use instead, you
 can find them and then provide the value you want to pass instead.
 For example, in the Firefox package, it uses a default value of
 'en-US' for `$locale`. If you want to change that, you can add
 `locale` and a value, which will replace `$locale` in the script,
 e.g. `choco download firefox --internalize locale=en-GB`.

Examples

choco download sysinternals

#### [Chocolatey for Business](https://chocolatey.org/compare) / Chocolatey for MSP
choco download notepadplusplus --internalize
choco download notepadplusplus.install --internalize --resources-location \\server\share
choco download notepadplusplus.install --internalize --resources-location http://somewhere/internal --append-useoriginallocation
choco download KB3033929 --internalize -internalize-all-urls --append-useoriginallocation
choco download firefox --internalize locale=es-AR

See It In Action

Coming soon

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

downloading multiple packages, and you use --version=1.0.0, it is going to look for and try to download version 1.0.0 of every package

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

-s, --source=VALUE Source - The source to find the package(s) to download. Defaults to default feeds.

 --version=VALUE
 Version - A specific version to download. Defaults to unspecified.

 --pre, --prerelease
 Prerelease - Include Prereleases? Defaults to false.

-u, --user=VALUE User - used with authenticated feeds. Defaults to empty.

-p, --password=VALUE Password - the user's password to the source. Defaults to empty.

 --cert=VALUE
 Client certificate - PFX pathname for an x509 authenticated feeds. 
   Defaults to empty.

 --cp, --certpassword=VALUE
 Certificate Password - the client certificate's password to the source. 
   Defaults to empty.

 --out, --outdir, --outputdirectory, --output-directory=VALUE
 OutputDirectory - Specifies the directory for the downloaded Chocolatey 
   package file. If not specified, uses the current directory.

-i, --ignoredependencies, --ignore-dependencies IgnoreDependencies - Ignore dependencies when installing package(s). Licensed editions v1.9.0+ Defaults to false.

 --installed, --installed-packages
 Installed Packages - Download all installed Chocolatey packages. 
   [Licensed editions](https://chocolatey.org/compare) v2.0.0+ Defaults to false.

 --ignore-unfound, --ignore-unfound-packages
 Ignore Unfound Packages - When downloading more than one package, 
   continue when one is unfound. [Licensed editions](https://chocolatey.org/compare) v2.0.0+ Defaults to 
   false.

 --disable-repository-optimizations, --disable-package-repository-optimizations
 Disable Package Repository Optimizations - Do not use optimizations for 
   reducing bandwidth with repository queries during package 
   install/upgrade/outdated operations. Should not generally be used, 
   unless a repository needs to support older methods of query. When used, 
   this makes queries similar to the way they were done in Chocolatey v0.1-
   0.11 and before. Overrides the default feature 
   'usePackageRepositoryOptimizations' set to 'True'. Available in 0.10.14+.

 --recompile, --internalize
 Recompile / Internalize - Download all external resources and recompile 
   the package to use the local resources instead. Business editions only 
   (licensed version 1.5.0+).

 --resources-location=VALUE
 Resources Location - When internalizing, use this location for resources 
   instead of embedding the downloaded resources into the package. Can be a 
   file share or an internal url location. When it is a file share, it will 
   attempt to download to that location. When it is an internal url, it 
   will download locally and give further instructions on where it should 
   be uploaded to match package edits. Business editions only (licensed 
   version 1.5.1+).

 --download-location=VALUE
 Download Location - OPTIONAL - When internalizing, download the 
   resources to this location. Used with Resources Location (and defaults 
   to Resources Location when not set). Business editions only (licensed 
   version 1.8.3+).

-a, --all-urls, --internalize-all, --internalize-all-urls All Urls - OPTIONAL - When internalizing, Chocolatey would normally only internalize packages with known helpers. Add this switch to make it download anytime a URL is found. Business editions only (licensed version 1.12.0+).

 --append-useoriginallocation, --append-use-original-location
 Append -UseOriginalLocation - When `Install-ChocolateyPackage` is 
   internalized, append the `-UseOriginalLocation` parameter to the 
   function. Business editions only (licensed version 1.7.0+). Requires at 
   least Chocolatey v0.10.1 for `Install-ChocolateyPackage` to recognize 
   the switch appropriately. Overrides the feature 
   'internalizeAppendUseOriginalLocation' set to by default to 'True'.

 --sdc, --skipdownloadcache, --skip-download-cache
 Skip Download Cache - Use the original download url even if a private 
   CDN cache is available for a package. Overrides the default feature 
   'downloadCache' set to 'True'. Business editions only (licensed version 
   1.12.2+). See https://docs.chocolatey.org/en-us/features/private-cdn 

 --dc, --downloadcache, --download-cache, --use-download-cache
 Use Download Cache - Use private CDN cache if available for a package. 
   Overrides the default feature 'downloadCache' set to 'True'. Business 
   editions only (licensed version 1.12.2+). See https://docs.chocolate-
   y.org/en-us/features/private-cdn 

 --svc, --skipvirus, --skip-virus, --skipviruscheck, --skip-virus-check
 Skip Virus Check - Skip the virus check for downloaded files on this ru-
   n. Overrides the default feature 'virusCheck' set to 'False'. Licensed 
   editions 2.1.0+. See https://docs.chocolatey.org/en-us/features/virus-check 

 --virus, --viruscheck, --virus-check
 Virus Check - check downloaded files for viruses. Overrides the default 
   feature 'virusCheck' set to 'False'. [Licensed editions](https://chocolatey.org/compare) 2.1.0+. See 
   https://docs.chocolatey.org/en-us/features/virus-check 

 --viruspositivesmin, --virus-positives-minimum=VALUE
 Virus Check Minimum Scan Result Positives - the minimum number of scan 
   result positives required to flag a package. Used when virusScannerType 
   is VirusTotal. Overrides the default configuration value 
   'virusCheckMinimumPositives' set to '4'. [Licensed editions](https://chocolatey.org/compare) 2.1.0+. See 
   https://docs.chocolatey.org/en-us/features/virus-check

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco download -h.

=== --- Order: 45 xref: choco-command-features Title: Features Description: Features Command (choco features) RedirectFrom: - docs/commandsfeatures - docs/commands-features ShowInNavbar: false

ShowInSidebar: false

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Feature Command (choco features)

Chocolatey will allow you to interact with features.

Usage

choco feature [list]|disable|enable [<options/switches>]

Examples

choco feature
choco feature list
choco feature disable -n=bob
choco feature enable -n=bob

:memo: NOTE See scripting in how to pass arguments (choco -?) for how to write proper scripts and integrations.

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

If you find other exit codes that we have not yet documented, please file a ticket so we can document it at https://github.com/chocolatey/choco/issues/new/choose.

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

-n, --name=VALUE Name - the name of the source. Required with actions other than list. Defaults to empty.

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco features -h.

=== --- Order: 140 xref: choco-command-source Title: Source Description: Source Command (choco source) RedirectFrom: - docs/commandssource

- docs/commands-source

:memo: WARNING SHIM DEPRECATION

With the release of Chocolatey CLI v1.0.0 we have deprecated the following shims/shortcuts:

chocolatey (Alias for choco)

cinst (Shortcut for choco install)

cpush (Shortcut for choco push)

cuninst (Shortcut for cuninst)

cup (Shortcut for choco upgrade)

We recommend that any scripts calling these shims be updated to use the full command, as these shims will be removed in Chocolatey CLI v2.0.0.

Source Command (choco source)

Chocolatey will allow you to interact with sources.

:memo: NOTE Mostly compatible with older chocolatey client (0.9.8.x and below) with options and switches. When enabling, disabling or removing a source, use -name in front of the option now. In most cases you can still pass options and switches with one dash (-). For more details, see how to pass arguments (choco -?).

Usage

choco source [list]|add|remove|disable|enable [<options/switches>]
choco sources [list]|add|remove|disable|enable [<options/switches>]

Examples

choco source
choco source list
choco source add -n=bob -s="https://somewhere/out/there/api/v2/"
choco source add -n=bob -s "'https://somewhere/out/there/api/v2/'" -cert=\Users\bob\bob.pfx
choco source add -n=bob -s "'https://somewhere/out/there/api/v2/'" -u=bob -p=12345
choco source disable -n=bob
choco source enable -n=bob
choco source remove -n=bob

:memo: NOTE See scripting in how to pass arguments (choco -?) for how to write proper scripts and integrations.

Exit Codes

Exit codes that normally result from running this command.

Normal: - 0: operation was successful, no issues detected - -1 or 1: an error has occurred

If you find other exit codes that we have not yet documented, please file a ticket so we can document it at https://github.com/chocolatey/choco/issues/new/choose.

Options and Switches

:memo: NOTE Options and switches apply to all items passed, so if you are running a command like install that allows installing multiple packages, and you use --version=1.0.0, it is going to look for and try to install version 1.0.0 of every package passed. So please split out multiple package calls when wanting to pass specific options.

Includes default options/switches (included below for completeness).

~~~

-?, --help, -h Prints out the help menu.

-d, --debug Debug - Show debug messaging.

-v, --verbose Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.

 --trace
 Trace - Show trace messaging. Very, very verbose trace messaging. Avoid 
   except when needing super low-level .NET Framework debugging. Available 
   in 0.10.4+.

 --nocolor, --no-color
 No Color - Do not show colorization in logging output. This overrides 
   the feature 'logWithoutColor', set to 'False'. Available in 0.10.9+.

 --acceptlicense, --accept-license
 AcceptLicense - Accept license dialogs automatically. Reserved for 
   future use.

-y, --yes, --confirm Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --accept-license

-f, --force Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.

 --noop, --whatif, --what-if
 NoOp / WhatIf - Don't actually do anything.

-r, --limitoutput, --limit-output LimitOutput - Limit the output to essential information

 --timeout, --execution-timeout=VALUE
 CommandExecutionTimeout (in seconds) - The time to allow a command to 
   finish before timing out. Overrides the default execution timeout in the 
   configuration of 2700 seconds. '0' for infinite starting in 0.10.4.

-c, --cache, --cachelocation, --cache-location=VALUE CacheLocation - Location for download cache, defaults to %TEMP% or value in chocolatey.config file.

 --allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
 AllowUnofficialBuild - When not using the official build you must set 
   this flag for choco to continue.

 --failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
 FailOnStandardError - Fail on standard error output (stderr), typically 
   received when running external commands during install providers. This 
   overrides the feature failOnStandardError.

 --use-system-powershell
 UseSystemPowerShell - Execute PowerShell using an external process 
   instead of the built-in PowerShell host. Should only be used when 
   internal host is failing. Available in 0.9.10+.

 --no-progress
 Do Not Show Progress - Do not show download progress percentages. 
   Available in 0.10.4+.

 --proxy=VALUE
 Proxy Location - Explicit proxy location. Overrides the default proxy 
   location of ''. Available for config settings in 0.9.9.9+, this CLI 
   option available in 0.10.4+.

 --proxy-user=VALUE
 Proxy User Name - Explicit proxy user (optional). Requires explicit 
   proxy (`--proxy` or config setting). Overrides the default proxy user of 
   ''. Available for config settings in 0.9.9.9+, this CLI option available 
   in 0.10.4+.

 --proxy-password=VALUE
 Proxy Password - Explicit proxy password (optional) to be used with 
   username. Requires explicit proxy (`--proxy` or config setting) and user 
   name.  Overrides the default proxy password (encrypted in settings if 
   set). Available for config settings in 0.9.9.9+, this CLI option 
   available in 0.10.4+.

 --proxy-bypass-list=VALUE
 ProxyBypassList - Comma separated list of regex locations to bypass on 
   proxy. Requires explicit proxy (`--proxy` or config setting). Overrides 
   the default proxy bypass list of ''. Available in 0.10.4+.

 --proxy-bypass-on-local
 Proxy Bypass On Local - Bypass proxy for local connections. Requires 
   explicit proxy (`--proxy` or config setting). Overrides the default 
   proxy bypass on local setting of 'True'. Available in 0.10.4+.

 --log-file=VALUE
 Log File to output to in addition to regular loggers. Available in 0.1-
   0.8+.

 --skipcompatibilitychecks, --skip-compatibility-checks
 SkipCompatibilityChecks - Prevent warnings being shown before and after 
   command execution when a runtime compatibility problem is found between 
   the version of Chocolatey and the Chocolatey Licensed Extension. 
   Available in 1.1.0+

-n, --name=VALUE Name - the name of the source. Required with actions other than list. Defaults to empty.

-u, --user=VALUE User - used with authenticated feeds. Defaults to empty.

-p, --password=VALUE Password - the user's password to the source. Encrypted in chocolate- y.config file.

 --cert=VALUE
 Client certificate - PFX pathname for an x509 authenticated feeds. 
   Defaults to empty. Available in 0.9.10+.

 --cp, --certpassword=VALUE
 Certificate Password - the client certificate's password to the source. 
   Defaults to empty. Available in 0.9.10+.

 --priority=VALUE
 Priority - The priority order of this source as compared to other 
   sources, lower is better. Defaults to 0 (no priority). All priorities 
   above 0 will be evaluated first, then zero-based values will be 
   evaluated in config file order. Available in 0.9.9.9+.

 --bypassproxy, --bypass-proxy
 Bypass Proxy - Should this source explicitly bypass any explicitly or 
   system configured proxies? Defaults to false. Available in 0.10.4+.

 --allowselfservice, --allow-self-service
 Allow Self-Service - Should this source be allowed to be used with self-
   service? Requires business edition (v1.10.0+) with feature 
   'useBackgroundServiceWithSelfServiceSourcesOnly' turned on. Defaults to 
   false. Available in 0.10.4+.

 --adminonly, --admin-only
 Visible to Administrators Only - Should this source be visible to non-
   administrators? Requires business edition (v1.12.2+). Defaults to false. 
   Available in 0.10.8+.

~~~

Command Reference

:memo: NOTE This documentation has been automatically generated from choco source -h.

Tags:
cli, documentation, inbox, index, snippets