Push

Push Command (choco push)

Chocolatey will attempt to push a compiled nupkg to a package feed.

A feed can be a local folder, a file share, the community feed (https://push.chocolatey.org/), or a custom/private feed. For web feeds, it has a requirement that it implements the proper OData endpoints required for NuGet packages.

Usage

    choco push [<path to nupkg>] [<options/switches>]

:choco-info: NOTE

If there is more than one nupkg file in the folder, the command will require specifying the path to the file.

Examples

    choco push --source https://push.chocolatey.org/
    choco push --source "'https://push.chocolatey.org/'" --execution-timeout 500
    choco push --source "'https://push.chocolatey.org/'" -k="'123-123123-123'"

:choco-info: NOTE

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

Troubleshooting

To use this command, you must have your API key saved for the community feed (chocolatey.org) or the source you want to push to. Or you can explicitly pass the apikey to the command. See `apikey` command help for instructions on saving your key:

    choco apikey -?

A common error is Failed to process request. 'The specified API key does not provide the authority to push packages.' The remote server returned an error: (403) Forbidden.. This means the package already exists with a different user (API key). The package could be unlisted. You can verify by going to https://community.chocolatey.org/packages/packageName. Please contact the administrators of https://community.chocolatey.org/ if you see this and you don’t see a good reason for it.

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

: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+

 -s, --source=VALUE
     Source - The source we are pushing the package to. Use https://pus-
       h.chocolatey.org/ to push to [community feed](https://community.chocolatey.org/packages).

 -k, --key, --apikey, --api-key=VALUE
     ApiKey - The API key for the source. If not specified (and not local 
       file source), does a lookup. If not specified and one is not found for 
       an https source, push will fail.

Command Reference

:choco-info: NOTE

This documentation has been automatically generated from choco push -h.

Edit This Page

On This Page

Usage
Examples
Troubleshooting
Exit Codes
Options and Switches