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 |
---|---|
Cake |
An attribute used for documentation of alias methods/properties. |
Methods
Name | Value | Summary |
---|---|---|
ChocolateyAddSource |
void |
Adds Chocolatey package source using the specified name &source to global user config.
static
|
ChocolateyAddSource |
void |
Adds Chocolatey package source using the specified name, source & settings to global user config.
static
|
ChocolateyApiKey |
void |
Sets the Api Key for a Chocolatey Source using the specified settings.
static
|
ChocolateyConfig |
void |
Sets the config parameter using the specified settings.
static
|
Chocolatey |
void |
Disables a Chocolatey Feature using the specified name.
static
|
Chocolatey |
void |
Disables a Chocolatey Feature using the specified name and settings.
static
|
Chocolatey |
void |
Disables a Chocolatey Source using the specified name.
static
|
Chocolatey |
void |
Disables a Chocolatey Source using the specified name and settings.
static
|
ChocolateyDownload |
void |
Downloads a Chocolatey package to the current working directory.
Requires Chocolatey licensed edition.
static
|
ChocolateyDownload |
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
|
Chocolatey |
void |
Enables a Chocolatey Feature using the specified name.
static
|
Chocolatey |
void |
Enables a Chocolatey Feature using the specified name and settings.
static
|
Chocolatey |
void |
Enables a Chocolatey Source using the specified name.
static
|
Chocolatey |
void |
Enables a Chocolatey Source using the specified name and settings.
static
|
ChocolateyInstall |
void |
Installs a Chocolatey package.
static
|
ChocolateyInstall |
void |
Installs a Chocolatey package using the specified settings.
static
|
Chocolatey |
void |
Installs Chocolatey packages using the specified package configuration.
static
|
Chocolatey |
void |
Installs Chocolatey packages using the specified package configuration and settings.
static
|
ChocolateyNew |
void |
Generate package specification files for a new package using the default settings.
static
|
ChocolateyNew |
void |
Generate package specification files for a new package using the specified settings.
static
|
ChocolateyPack |
void |
Creates a Chocolatey package using the specified settings.
static
|
ChocolateyPack |
void |
Creates a Chocolatey package using the specified Nuspec file.
static
|
ChocolateyPack |
void |
Creates Chocolatey packages using the specified Nuspec files.
static
|
ChocolateyPin |
void |
Pins a Chocolatey package using the specified settings.
static
|
ChocolateyPush |
void |
Pushes a Chocolatey package to a Chocolatey server and publishes it.
static
|
ChocolateyPush |
void |
Pushes Chocolatey packages to a Chocolatey server and publishes them.
static
|
Chocolatey |
void |
Removes Chocolatey package source using the specified name & source from global user config.
static
|
Chocolatey |
void |
Removes Chocolatey package source using the specified name, source & settings from global user config.
static
|
ChocolateyUninstall |
void |
Uninstalls a Chocolatey package.
static
|
ChocolateyUninstall |
void |
Uninstalls Chocolatey packages using the specified settings.
static
|
ChocolateyUninstall |
void |
Uninstalls a Chocolatey package.
static
|
ChocolateyUninstall |
void |
Uninstalls a Chocolatey package using the specified settings.
static
|
ChocolateyUpgrade |
void |
Upgrades Chocolatey package.
static
|
ChocolateyUpgrade |
void |
Upgrades Chocolatey package using the specified settings.
static
|
Extension Methods
Name | Value | Summary |
---|---|---|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|