Chocolatey aliases

Built-In

Contains functionality for working with Chocolatey.

In order to use the commands for this alias, Chocolatey will require to be installed on the machine where the build script is being run. See this page for details on how Chocolatey can be installed.

AddSource

ChocolateyAddSource(string, string, ChocolateySourcesSettings) Adds Chocolatey package source using the specified name, source & settings to global user config.
ChocolateyAddSource(string, string) Adds Chocolatey package source using the specified name &source to global user config.

ApiKey

ChocolateyApiKey(string, ChocolateyApiKeySettings) Sets the Api Key for a Chocolatey Source using the specified settings.

Config

ChocolateyConfig(string, string, ChocolateyConfigSettings) Sets the config parameter using the specified settings.

DisableFeature

ChocolateyDisableFeature(string, ChocolateyFeatureSettings) Disables a Chocolatey Feature using the specified name and settings.
ChocolateyDisableFeature(string) Disables a Chocolatey Feature using the specified name.

DisableSource

ChocolateyDisableSource(string, ChocolateySourcesSettings) Disables a Chocolatey Source using the specified name and settings.
ChocolateyDisableSource(string) Disables a Chocolatey Source using the specified name.

Download

ChocolateyDownload(string, ChocolateyDownloadSettings) Downloads a Chocolatey package using the specified settings. Requires Chocolatey licensed edition. Features requiring Chocolatey for Business or a minimum version are documented in ChocolateyDownloadSettings.
ChocolateyDownload(string) Downloads a Chocolatey package to the current working directory. Requires Chocolatey licensed edition.

EnableFeature

ChocolateyEnableFeature(string, ChocolateyFeatureSettings) Enables a Chocolatey Feature using the specified name and settings.
ChocolateyEnableFeature(string) Enables a Chocolatey Feature using the specified name.

EnableSource

ChocolateyEnableSource(string, ChocolateySourcesSettings) Enables a Chocolatey Source using the specified name and settings.
ChocolateyEnableSource(string) Enables a Chocolatey Source using the specified name.

Export

ChocolateyExport(ChocolateyExportSettings) Exports the currently installed Chocolatey packages using the specified settings.
ChocolateyExport() Exports the currently installed Chocolatey packages to a packages.config file in the current working directory.

Install

ChocolateyInstall(string, ChocolateyInstallSettings) Installs a Chocolatey package using the specified settings.
ChocolateyInstall(string) Installs a Chocolatey package.
ChocolateyInstallFromConfig(FilePath, ChocolateyInstallSettings) Installs Chocolatey packages using the specified package configuration and settings.
ChocolateyInstallFromConfig(FilePath) Installs Chocolatey packages using the specified package configuration.

New

ChocolateyNew(string, ChocolateyNewSettings) Generate package specification files for a new package using the specified settings.
ChocolateyNew(string) Generate package specification files for a new package using the default settings.

Pack

ChocolateyPack(ChocolateyPackSettings) Creates a Chocolatey package using the specified settings.
ChocolateyPack(FilePath, ChocolateyPackSettings) Creates a Chocolatey package using the specified Nuspec file.
ChocolateyPack(IEnumerable<FilePath>, ChocolateyPackSettings) Creates Chocolatey packages using the specified Nuspec files.

Pin

ChocolateyPin(string, ChocolateyPinSettings) Pins a Chocolatey package using the specified settings.

Push

ChocolateyPush(FilePath, ChocolateyPushSettings) Pushes a Chocolatey package to a Chocolatey server and publishes it.
ChocolateyPush(IEnumerable<FilePath>, ChocolateyPushSettings) Pushes Chocolatey packages to a Chocolatey server and publishes them.

RemoveSource

ChocolateyRemoveSource(string, ChocolateySourcesSettings) Removes Chocolatey package source using the specified name, source & settings from global user config.
ChocolateyRemoveSource(string) Removes Chocolatey package source using the specified name & source from global user config.

Uninstall

ChocolateyUninstall(IEnumerable<string>, ChocolateyUninstallSettings) Uninstalls Chocolatey packages using the specified settings.
ChocolateyUninstall(IEnumerable<string>) Uninstalls a Chocolatey package.
ChocolateyUninstall(string, ChocolateyUninstallSettings) Uninstalls a Chocolatey package using the specified settings.
ChocolateyUninstall(string) Uninstalls a Chocolatey package.

Upgrade

ChocolateyUpgrade(string, ChocolateyUpgradeSettings) Upgrades Chocolatey package using the specified settings.
ChocolateyUpgrade(string) Upgrades Chocolatey package.