NuGetAliases Class

Summary

Contains functionality for working with NuGet.
Namespace
Cake.Common.Tools.NuGet
Base Types
  • object
graph BT Type-->Base0["object"] Type["NuGetAliases"] class Type type-node

Syntax

[CakeAliasCategory("NuGet")]
public static class NuGetAliases

Attributes

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

Methods

Name Value Summary
NuGetAdd(ICakeContext, string, NuGetAddSettings) void
Adds a NuGet package using package id and source.
static
NuGetAdd(ICakeContext, string, string) void
Adds a NuGet package using package id and source.
static
NuGetAddSource(ICakeContext, string, string, NuGetSourcesSettings) void
Adds NuGet package source using the specified name, source & settings to global user config.
static
NuGetAddSource(ICakeContext, string, string) void
Adds NuGet package source using the specified name &source to global user config.
static
NuGetDelete(ICakeContext, string, string, NuGetDeleteSettings) void
Deletes or unlists a package from a package source.
static
NuGetHasSource(ICakeContext, string, NuGetSourcesSettings) bool
Checks whether or not a NuGet package source exists in the global user configuration, using the specified source and settings.
static
NuGetHasSource(ICakeContext, string) bool
Checks whether or not a NuGet package source exists in the global user configuration, using the specified source.
static
NuGetInit(ICakeContext, string, string, NuGetInitSettings) void
Adds all packages from source to destination using specified settings.
static
NuGetInit(ICakeContext, string, string) void
Adds all packages from source to destination.
static
NuGetInstall(ICakeContext, IEnumerable<string>, NuGetInstallSettings) void
Installs NuGet packages using the specified settings.
static
NuGetInstall(ICakeContext, IEnumerable<string>) void
Installs NuGet packages.
static
NuGetInstall(ICakeContext, string, NuGetInstallSettings) void
Installs a NuGet package using the specified settings.
static
NuGetInstall(ICakeContext, string) void
Installs a NuGet package.
static
NuGetInstallFromConfig(ICakeContext, FilePath, NuGetInstallSettings) void
Installs NuGet packages using the specified package configuration and settings.
static
NuGetInstallFromConfig(ICakeContext, FilePath) void
Installs NuGet packages using the specified package configuration.
static
NuGetInstallFromConfig(ICakeContext, IEnumerable<FilePath>, NuGetInstallSettings) void
Installs NuGet packages using the specified package configurations and settings.
static
NuGetInstallFromConfig(ICakeContext, IEnumerable<FilePath>) void
Installs NuGet packages using the specified package configurations.
static
NuGetList(ICakeContext, NuGetListSettings) IEnumerable<NuGetListItem>
List packages on available from source using specified settings.
static
NuGetList(ICakeContext, string, NuGetListSettings) IEnumerable<NuGetListItem>
List packages on available from source using specified settings.
static
NuGetList(ICakeContext, string) IEnumerable<NuGetListItem>
List packages on available from source using specified settings.
static
NuGetPack(ICakeContext, FilePath, NuGetPackSettings) void
Creates a NuGet package using the specified nuspec or project file.
static
NuGetPack(ICakeContext, IEnumerable<FilePath>, NuGetPackSettings) void
Creates NuGet packages using the specified nuspec or project files.
static
NuGetPack(ICakeContext, NuGetPackSettings) void
Creates a NuGet package using the specified settings.
static
NuGetPush(ICakeContext, FilePath, NuGetPushSettings) void
Pushes a NuGet package to a NuGet server and publishes it.
static
NuGetPush(ICakeContext, IEnumerable<FilePath>, NuGetPushSettings) void
Pushes NuGet packages to a NuGet server and publishes them.
static
NuGetRemoveSource(ICakeContext, string, string, NuGetSourcesSettings) void
Removes NuGet package source using the specified name, source & settings from global user config.
static
NuGetRemoveSource(ICakeContext, string, string) void
Removes NuGet package source using the specified name & source from global user config.
static
NuGetRestore(ICakeContext, FilePath, NuGetRestoreSettings) void
Restores NuGet packages using the specified settings.
static
NuGetRestore(ICakeContext, FilePath) void
Restores NuGet packages for the specified target.
static
NuGetRestore(ICakeContext, IEnumerable<FilePath>, NuGetRestoreSettings) void
Restores NuGet packages using the specified settings.
static
NuGetRestore(ICakeContext, IEnumerable<FilePath>) void
Restores NuGet packages for the specified targets.
static
NuGetSetApiKey(ICakeContext, string, string, NuGetSetApiKeySettings) void
Installs NuGet packages using the specified API key, source and settings.
static
NuGetSetApiKey(ICakeContext, string, string) void
Installs NuGet packages using the specified API key and source.
static
NuGetSetProxy(ICakeContext, string, string, string, NuGetSetProxySettings) void
Set the proxy settings to be used while connecting to your NuGet feed, including settings.
static
NuGetSetProxy(ICakeContext, string, string, string) void
Set the proxy settings to be used while connecting to your NuGet feed.
static
NuGetUpdate(ICakeContext, FilePath, NuGetUpdateSettings) void
Updates NuGet packages using the specified settings.
static
NuGetUpdate(ICakeContext, FilePath) void
Updates NuGet packages.
static
NuGetUpdate(ICakeContext, IEnumerable<FilePath>, NuGetUpdateSettings) void
Updates NuGet packages using the specified settings.
static
NuGetUpdate(ICakeContext, IEnumerable<FilePath>) void
Updates NuGet packages.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin