Skip to content

Latest commit

 

History

History
122 lines (91 loc) · 5.17 KB

CommandsReference.md

File metadata and controls

122 lines (91 loc) · 5.17 KB

Command Reference

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

Commands

  • [[list / search |CommandsList]] - searches and lists remote or local packages
  • [[install|CommandsInstall]] - installs packages from various sources
  • installmissing - REMOVED
  • update - DEPRECATED - RESERVED for future use (You are looking for upgrade, these are not the droids you are looking for)
  • [[outdated|CommandsOutdated]] - show a list of packages that have updates (similar to choco upgrade --noop, but only outputs out of date packages, current version and available update version).
  • [[upgrade|CommandsUpgrade]] - upgrades packages from various sources
  • version - DEPRECATED - will be removed in v1 - use choco upgrade <pkg|all> -whatif instead
  • [[uninstall|CommandsUninstall]] - uninstalls a package
  • help - REMOVED - use -h on any command.

Commands (intermediate to advanced)

  • [[config|CommandsConfig]] - Retrieve and configure config file settings
  • [[source / sources|CommandsSources]] - view and configure default sources
  • [[apikey / setapikey|CommandsApiKey]] - retrieves or saves an apikey for a particular source
  • [[pin|CommandsPin]] - suppress upgrades to a package

Package Creation Commands

  • [[new|CommandsNew]] - generates files necessary for a Chocolatey package from a template
  • [[pack|CommandsPack]] - packages up a nuspec to a compiled nupkg
  • [[push|CommandsPush]] - pushes a compiled nupkg

See Help Menu In Action

choco help in action

Default Options and Switches

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

 -d, --debug
     Debug - Run in Debug Mode.

 -v, --verbose
     Verbose - See verbose messaging.

     --acceptlicense, --accept-license
     AcceptLicense - Accept license dialogs automatically.

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

 -f, --force
     Force - force the behavior

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

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

     --execution-timeout=VALUE
     CommandExecutionTimeoutSeconds - Override the default execution timeout 
       in the configuration of 2700 seconds.

 -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. Available in 0.9.10+.

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.
  • 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.
  • 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.