ChocolateyAliases Class

Summary

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.

Namespace
Cake.Common.Tools.Chocolatey
Base Types
  • object
graph BT Type-->Base0["object"] Type["ChocolateyAliases"] class Type type-node

Syntax

[CakeAliasCategory("Chocolatey")]
public static class ChocolateyAliases

Attributes

Type Description
CakeAliasCategoryAttribute An attribute used for documentation of alias methods/properties.

Methods

Name Value Summary
ChocolateyAddSource(ICakeContext, string, string) void
Adds Chocolatey package source using the specified name &source to global user config.
static
ChocolateyAddSource(ICakeContext, string, string, ChocolateySourcesSettings) void
Adds Chocolatey package source using the specified name, source & settings to global user config.
static
ChocolateyApiKey(ICakeContext, string, string, ChocolateyApiKeySettings) void
Sets the Api Key for a Chocolatey Source using the specified settings.
static
ChocolateyConfig(ICakeContext, string, string, ChocolateyConfigSettings) void
Sets the config parameter using the specified settings.
static
ChocolateyDisableFeature(ICakeContext, string) void
Disables a Chocolatey Feature using the specified name.
static
ChocolateyDisableFeature(ICakeContext, string, ChocolateyFeatureSettings) void
Disables a Chocolatey Feature using the specified name and settings.
static
ChocolateyDisableSource(ICakeContext, string) void
Disables a Chocolatey Source using the specified name.
static
ChocolateyDisableSource(ICakeContext, string, ChocolateySourcesSettings) void
Disables a Chocolatey Source using the specified name and settings.
static
ChocolateyDownload(ICakeContext, string) void
Downloads a Chocolatey package to the current working directory. Requires Chocolatey licensed edition.
static
ChocolateyDownload(ICakeContext, string, ChocolateyDownloadSettings) void
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.
static
ChocolateyEnableFeature(ICakeContext, string) void
Enables a Chocolatey Feature using the specified name.
static
ChocolateyEnableFeature(ICakeContext, string, ChocolateyFeatureSettings) void
Enables a Chocolatey Feature using the specified name and settings.
static
ChocolateyEnableSource(ICakeContext, string) void
Enables a Chocolatey Source using the specified name.
static
ChocolateyEnableSource(ICakeContext, string, ChocolateySourcesSettings) void
Enables a Chocolatey Source using the specified name and settings.
static
ChocolateyInstall(ICakeContext, string) void
Installs a Chocolatey package.
static
ChocolateyInstall(ICakeContext, string, ChocolateyInstallSettings) void
Installs a Chocolatey package using the specified settings.
static
ChocolateyInstallFromConfig(ICakeContext, FilePath) void
Installs Chocolatey packages using the specified package configuration.
static
ChocolateyInstallFromConfig(ICakeContext, FilePath, ChocolateyInstallSettings) void
Installs Chocolatey packages using the specified package configuration and settings.
static
ChocolateyNew(ICakeContext, string) void
Generate package specification files for a new package using the default settings.
static
ChocolateyNew(ICakeContext, string, ChocolateyNewSettings) void
Generate package specification files for a new package using the specified settings.
static
ChocolateyPack(ICakeContext, ChocolateyPackSettings) void
Creates a Chocolatey package using the specified settings.
static
ChocolateyPack(ICakeContext, FilePath, ChocolateyPackSettings) void
Creates a Chocolatey package using the specified Nuspec file.
static
ChocolateyPack(ICakeContext, IEnumerable<FilePath>, ChocolateyPackSettings) void
Creates Chocolatey packages using the specified Nuspec files.
static
ChocolateyPin(ICakeContext, string, ChocolateyPinSettings) void
Pins a Chocolatey package using the specified settings.
static
ChocolateyPush(ICakeContext, FilePath, ChocolateyPushSettings) void
Pushes a Chocolatey package to a Chocolatey server and publishes it.
static
ChocolateyPush(ICakeContext, IEnumerable<FilePath>, ChocolateyPushSettings) void
Pushes Chocolatey packages to a Chocolatey server and publishes them.
static
ChocolateyRemoveSource(ICakeContext, string) void
Removes Chocolatey package source using the specified name & source from global user config.
static
ChocolateyRemoveSource(ICakeContext, string, ChocolateySourcesSettings) void
Removes Chocolatey package source using the specified name, source & settings from global user config.
static
ChocolateyUninstall(ICakeContext, IEnumerable<string>) void
Uninstalls a Chocolatey package.
static
ChocolateyUninstall(ICakeContext, IEnumerable<string>, ChocolateyUninstallSettings) void
Uninstalls Chocolatey packages using the specified settings.
static
ChocolateyUninstall(ICakeContext, string) void
Uninstalls a Chocolatey package.
static
ChocolateyUninstall(ICakeContext, string, ChocolateyUninstallSettings) void
Uninstalls a Chocolatey package using the specified settings.
static
ChocolateyUpgrade(ICakeContext, string) void
Upgrades Chocolatey package.
static
ChocolateyUpgrade(ICakeContext, string, ChocolateyUpgradeSettings) void
Upgrades Chocolatey package using the specified settings.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin