Skip to content

Instantly share code, notes, and snippets.

@rasa
Last active March 1, 2019 06:49
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save rasa/aaf378e7de2ced474e4d8946cb7e05c3 to your computer and use it in GitHub Desktop.
Save rasa/aaf378e7de2ced474e4d8946cb7e05c3 to your computer and use it in GitHub Desktop.

back to top

choco command [options]

Common commands:

config      Retrieve and configure config file settings
install     Install packages from various sources
list        List remote or local packages
outdated    Retrieve packages that are outdated. Similar to upgrade all --noop
search      Search remote or local packages (alias for list)
upgrade     Upgrade packages from various sources
uninstall   Uninstall a package

Other commands:

apikey      Retrieve or save an apikey for a particular source
download    Download packages - optionally internalizing all remote resources
feature     View and configure choco features (features works too)
info        Retrieve package information. Shorthand for choco search pkgname --exact --verbose
new         Generate files necessary for a chocolatey package from a template
optimize    Optimize installation, reducing space usage
pin         Suppress upgrades for a package
pack        Package up a nuspec to a compiled nupkg
push        Push a compiled nupkg
setapikey   Retrieve or save an apikey for a particular source (alias for apikey)
source      View and configure default sources (sources works too)
support     Provide support information
unpackself  Have chocolatey set itself up

Default Options and Switches (common to all commands):

-c DIR                  Location for download Cache, defaults to %TEMP% or value in chocolatey.config 
-d                      Show Debug messaging
-f                      Force the behavior. Do not use force during normal operation - it subverts some of the
                        smart behavior for commands
-v                      Show Verbose messaging. Very verbose messaging, avoid using under normal circumstances
-r                      Limit the output to essential information
-y                      Automatically answers yes to all prompts. Implies --accept-license
-?                      Print out the help menu

--acceptlicense         Accept license dialogs automatically. Reserved for future use
--allowunofficial       When not using the official build you must set this flag for choco to continue
--failstderr            Report failures on standard error, typically received when running external commands 
                        during install providers. This overrides the feature failOnStandardError
--nocolor               Do not show colorization in logging output. Overrides 'logWithoutColor', set to 'False'
--noop                  Don't actually do anything
--no-progress           Do not show download progress percentages
--trace                 Show trace messaging. Very, very verbose trace messaging.
                        Avoid except when needing super low-level .NET Framework debugging 
--timeout SECS          Command execution timeout: Seconds to allow a command to finish before timing out.
                        Overrides the default configuration of 2700 seconds. '0' for infinite
--use-system-powershell Execute PowerShell using an external process instead of the built-in PowerShell host
                        Should only be used when internal host is failing

Proxy options:

--proxy HOST              Proxy location. Default: none
--proxy-user USER         Proxy user. Requires explicit proxy (--proxy or config setting). Default: none
--proxy-password PASSWORD Proxy password. Requires explicit proxy (--proxy` or config setting) and user name.
                          Overrides the default proxy password (encrypted in settings if set).
--proxy-bypass-list VALUE Comma separated list of regex locations to bypass on proxy. 
                          Requires explicit proxy (--proxy or config setting). Default: none
--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'

back to top

back to top

choco install [options] package [package]...

Common options:

-f              Force the behavior. Do not use force during normal operation - it subverts some of the smart
                behavior for commands.
-o              Should install arguments be used exclusively without appending to current package passed arguments?
                Default: false
-s SOURCE       The source to find the package(s) to install: ruby, webpi, cygwin, windowsfeatures, or python.
                To specify multiple sources, separate with semicolons: "'ruby;webpi'"
-y              Confirm all prompts - Chooses affirmative answer instead of prompting. Implies --acceptlicense

--ia ARGS       Install Arguments to pass to the native installer in the package. Default: none
--params PARAMS Parameters to pass to the package. Default: none
--pre           Include Prereleases? Default: false
--version VER   A specific version VER to install. Default: none
--x86           Force x86 (32bit) installation on 64 bit systems. Default: false

Other options:

-i                Ignore dependencies when installing package(s). Default: false
-m                Should multiple versions of a package be installed? Default: false
-n                Skip Powershell - Do not run chocolateyInstall.ps1. Default: false
-x                Force dependencies to be reinstalled when force installing packages. Requires -f. Default: false
-p PASSWORD       The user's PASSWORD to the source. Default: none
-u USER           Used with authenticated feeds. Default: none

--allowdowngrade  Should an attempt at downgrading be allowed? Default: false
--argsglobal      Should install arguments be applied to dependent packages? Default: false
--cp PASSWORD     Client certificate's password to the source. Default: none
--cert PATH       Path to client certificate's PFX file for an x509 authenticated feeds. Default: none
--notsilent       Do not install this silently. Default: false
--paramsglobal    Should package parameters be applied to dependent packages? Defaults: false

--ignorepackagecodes    Exit with a 0 for success and 1 for non-success, no matter what package scripts provide for
                        exit codes. Overrides the default feature 'usePackageExitCodes' set to True.
--stoponfirstfailure    Stop running install, upgrade or uninstall on first package failure instead of continuing
                        with others. Overrides 'stopOnFirstPackageFailure' set to False.
--usepackagecodes       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.
--viruspositivesmin MIN The minimum number (MIN) of scan result positives required to flag a package. Used when
                        virusScannerType is VirusTotal. Overrides 'virusCheckMinimumPositives' set to '4'.

Checksum options:

--allowemptychecksum       Allow packages to have empty/missing checksums for downloaded resources from non-secure
                           locations (HTTP, FTP). This switch is not recommended if using sources that download
                           resources from the internet. Overrides 'allowEmptyChecksums' set to False
--allowemptychecksumsecure Allow packages to have empty checksums for downloaded resources from secure locations
                           (HTTPS). Overrides 'allowEmptyChecksumsSecure' set to True
--ignorechecksum           Ignore checksums provided by the package. Overrides 'checksumFiles' set to True
--checksum CHECKSUM        Download Checksum: checksum for downloaded resources for the package.
                           Overrides the package checksum (if it has one). Default: none
--checksum64 CHECKSUM      Download Checksum 64bit: checksum for 64bit downloaded resources for the package.
                           Overrides the package 64-bit checksum (if found). Defaults to Download Checksum.
--checksumtype TYPE        Download Checksum Type. Overrides the package checksum type (if it has one). Used in
                           conjunction with Download Checksum. Options: md5, sha1, sha256, sha512. Default: md5
--checksumtype64 TYPE      Download Checksum Type 64bit: checksum for 64bit downloaded resources for the package.
                           Overrides the package 64-bit checksum (if found). Used in conjunction with Download
                           Checksum 64bit. Options: md5, sha1, sha256, sha512. Default: Download Checksum Type
--requirechecksum          Require packages to have checksums for downloaded resources (both non-secure and secure).
                           Overrides 'allowEmptyChecksums' set to False and 'allowEmptyChecksumsSecure' set to True.

Licensed editions only:

--bps RATE          Maximum download rate in bits per second. '0' or empty means no maximum. Default: 0
--dc                Use Download Cache - Use private CDN cache if available for a package.
                    Overrides the default feature 'downloadCache' set to True
--dir DIR           Override the default installation directory. 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
--sdc               Skip Download Cache: Use the original download even if a private CDN cache is available for a
                    package. Overrides 'downloadCache' set to True
--svc               Skip Virus Check - Skip the virus check for downloaded files on this run.
                    Overrides the default feature 'virusCheck' set to True
--no-reduce         Do Not Reduce Installed Package Size - Leave the nupkg and files alone in the package
                    Overrides the default feature 'reduceInstalledPackageSpaceUsage' set to True
--reduce            Reducer Installed Package Size (Package Reducer): Reduce size of nupkg file and remove extracted
                    archives and installers. Overrides 'reduceInstalledPackageSpaceUsage' set to True
--reduce-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
--virus             Check downloaded files for viruses. Overrides the default feature 'virusCheck' set to True

--install-arguments-sensitive=ARGS    Install Arguments to pass to the native installer in the package that are
                                      sensitive and you do not want logged. Default: none
--package-parameters-sensitive=PARAMS Package Parameters to pass the package that are sensitive and you do not want
                                      logged. Default: none

back to top

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment