Sources
Sources
Source Command (choco sources)
Chocolatey will allow you to interact with sources.
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/.
:choco-info: 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
- 2: nothing to do (enhanced)
:choco-info: NOTE
Starting in v2.3.0, 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
:choco-info: 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.
--online
Online - Open help for specified command in default browser application.
This option only works when used in combintation with the -?/--help/-h
option. Available in 2.0.0+
-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.
--nocolor, --no-color
No Color - Do not show colorization in logging output. This overrides
the feature 'logWithoutColor', set to 'False'.
--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. Supply '0' to disable the timeout.
-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.
--no-progress
Do Not Show Progress - Do not show download progress percentages.
--proxy=VALUE
Proxy Location - Explicit proxy location. Overrides the default proxy
location of ''.
--proxy-user=VALUE
Proxy User Name - Explicit proxy user (optional). Requires explicit
proxy (`--proxy` or config setting). Overrides the default proxy user of
''.
--proxy-password=VALUE
Proxy Password - Explicit proxy password (optional) to be used with user
name. Encrypted. Requires explicit proxy (`--proxy` or config setting)
and user name (`--proxy-user` or config setting). Overrides the default
proxy password.
--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 ''.
--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'.
--log-file=VALUE
Log File to output to in addition to regular loggers.
--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+
--ignore-http-cache
IgnoreHttpCache - Ignore any HTTP caches that have previously been
created when querying sources, and create new caches. Available in 2.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.
--cp, --certpassword=VALUE
Certificate Password - the client certificate's password to the source.
Defaults to empty.
--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.
--bypassproxy, --bypass-proxy
Bypass Proxy - Should this source explicitly bypass any explicitly or
system configured proxies? Defaults to false.
--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.
--adminonly, --admin-only
Visible to Administrators Only - Should this source be visible to non-
administrators? Requires business edition (v1.12.2+). Defaults to false.
:choco-info: NOTE
This documentation has been automatically generated from
choco sources -h.