Skip to content
This repository has been archived by the owner on Dec 15, 2020. It is now read-only.

Latest commit

 

History

History
261 lines (191 loc) · 11.1 KB

CommandsDownload.md

File metadata and controls

261 lines (191 loc) · 11.1 KB
Raw

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://chocolatey.org/docs/features-automatically-recompile-packages

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

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|CommandsReference#default-options-and-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 explicity
       proxy (`--proxy` or config setting). Overrides the default proxy user of
       '123'. 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 explicity 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 explicity 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
       explicity 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+.

 -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](https://chocolatey.org/compare) v1.9.0+ Defaults to false.

     --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://chocolatey.org/docs/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://chocolate-
       y.org/docs/features-private-cdn

[[Command Reference|CommandsReference]]

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