Summary

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.

Namespace: Cake.Common.Tools.Chocolatey
Containing Type: ChocolateyAliases

Syntax

[CakeMethodAlias]
[CakeAliasCategory("Download")]
[CakeNamespaceImport("Cake.Common.Tools.Chocolatey.Download")]
public static void ChocolateyDownload(this ICakeContext context, string packageId, ChocolateyDownloadSettings settings)

Examples

Download a package to a specific folder:

ChocolateyDownload(
    "MyChocolateyPackage",
    new ChocolateyDownloadSettings {
        OutputDirectory = @"C:\download\"
    });

Download and internalize a package:

ChocolateyDownload(
    "MyChocolateyPackage",
    new ChocolateyDownloadSettings {
        Internalize = true
    });

Attributes

Type	Description
CakeMethodAliasAttribute	An attribute used to mark script method aliases.
CakeAliasCategoryAttribute	An attribute used for documentation of alias methods/properties.
CakeNamespaceImportAttribute	An attribute used to hint Cake about additional namespaces that need to be imported for an alias to work. This attribute can mark an extension method, the extension method class, or the assembly to provide a global set of imports.

Parameters

Name	Type	Description
context	ICakeContext	The context.
packageId	string	The id of the package to install.
settings	ChocolateyDownloadSettings	The settings.

Return Value

Type	Description
void