Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Chocolatey Cheat Sheet

Chocolatey

Homepage: Chocolatey.org

Chocolatey is a machine-level package manager and installer for software packages, built for the Windows NT platform.

It is an execution engine using the NuGet packaging infrastructure and Windows PowerShell to provide an automation tool for installing software on Windows machines, designed to simplify the process from the user perspective.

The name is an extension on a pun of NuGet (from "nougat") "because everyone loves Chocolatey nougat".

Chocolatey can be invoked by the PackageManagement module (Formerly 'OneGet') of PowerShell version 5.0.

Installation

To Install Chocolatey, from a Powershell Administrator console, simply do:

Set-Location $env:USERPROFILE
If ( ! ( Test-Path $PROFILE ) ) { New-Item -Force -ItemType File -Path $PROFILE; Add-Content -Path $PROFILE -Encoding UTF8 -Value "# Powershell Profile"; }
Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
RefreshEnv.cmd

And you're ready to go.

If you want a window interface instead of the powershell console, you can do: choco install chocolateygui.

Powershell Auto-Completion

The second line in the previous listing creates your powershell $PROFILE file.

If it doesn't already exist, Chocolatey will not add auto-completion to it.

In case you missed it, or if you would like to add it yourself, open your $PROFILE and copy/paste the following lines:

# Chocolatey
$ChocolateyProfile = "$env:ChocolateyInstall\helpers\chocolateyProfile.psm1"
if (Test-Path($ChocolateyProfile)) {
	Import-Module "$ChocolateyProfile"
}

Usage

Command Description
list lists remote or local packages
search searches remote or local packages
info retrieves package information
install installs packages from various sources
pin pins a package to suppress upgrades
outdated retrieves packages that are outdated
upgrade upgrades packages from various sources
uninstall uninstalls a package

See also the Chocolatey Command Reference for a complete list.

Examples

Command Description
Find a package
choco list List all chocolatey packages
choco search zip Search packages mentionning "zip"
choco search --by-tag compression Search packages by their tags
choco search --by-id-only zip Search packages with "zip" in the package name
choco search --order-by-popularity zip Filter and sort by package results by popularity
choco search --approved-only zip Only return approved packages
choco info 7zip Get information about 7zip package
Install
choco install 7zip Install
choco install 7zip --install-directory=P:\7z Install to a specific directory
Maintenance
choco list --localonly List installed packages
choco outdated List upgradable packages
choco upgrade all -y Upgrade all packages
Pinning
choco pin list List pinned packages
choco pin add --name 7zip Suppress upgrades for 7zip
choco pin remove --name 7zip Supress upgrades supression for 7zip ;)

Prefered search method: choco search --by-id-only --order-by-popularity --approved-only searchstring

Other Command line switches

Switches Description
--help Prints out the help menu.
--install-directory=VALUE Install Directory Override
-y, --yes Confirm all prompts.
-f, --force Force the behavior.
--what-if Don't actually do anything, simulate.
--execution-timeout=VALUE The time to allow a command to finish.
--fail-on-standard-error Fail on standard error output (stderr).
--use-system-powershell Execute PowerShell using an external process.
--debug Show debug messaging.
--verbose Show verbose messaging.
--trace Show trace messaging.
--log-file=VALUE Log File to output to in addition to regular loggers.
--no-color Do not show colorization in output.
--limit-output Limit the output to essential information.
--no-progress Do not show download progress percentages.
--allow-unofficial-build Allow the use of an unofficial build.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment