DotNetAliases Class

Summary

Contains functionality related to .NET CLI.

In order to use the commands for this alias, the .NET CLI tools will need to be installed on the machine where the Cake script is being executed. See this page for information on how to install.

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

Syntax

[CakeAliasCategory("DotNet")]
public static class DotNetAliases

Attributes

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

Methods

Name Value Summary
DotNetAddPackage(ICakeContext, string, DotNetPackageAddSettings) void
Adds or updates a package reference in a project file.
static
DotNetAddPackage(ICakeContext, string, string, DotNetPackageAddSettings) void
Adds or updates a package reference in a project file.
static
DotNetAddPackage(ICakeContext, string, string) void
Adds or updates a package reference in a project file.
static
DotNetAddPackage(ICakeContext, string) void
Adds or updates a package reference in a project file.
static
DotNetBuild(ICakeContext, string, DotNetBuildSettings) void
Build all projects.
static
DotNetBuild(ICakeContext, string) void
Build all projects.
static
DotNetBuildServerShutdown(ICakeContext, DotNetBuildServerShutdownSettings) void
Shuts down build servers that are started from dotnet.
static
DotNetBuildServerShutdown(ICakeContext) void
Shuts down build servers that are started from dotnet.
static
DotNetClean(ICakeContext, string, DotNetCleanSettings) void
Cleans a project's output.
static
DotNetClean(ICakeContext, string) void
Cleans a project's output.
static
DotNetExecute(ICakeContext, FilePath, ProcessArgumentBuilder, DotNetExecuteSettings) void
Execute an assembly with arguments in the specific path with settings.
static
DotNetExecute(ICakeContext, FilePath, ProcessArgumentBuilder) void
Execute an assembly with arguments in the specific path.
static
DotNetExecute(ICakeContext, FilePath) void
Execute an assembly.
static
DotNetFormat(ICakeContext, string, DotNetFormatSettings) void
Formats code to match editorconfig settings.
static
DotNetFormat(ICakeContext, string) void
Formats code to match editorconfig settings.
static
DotNetFormatAnalyzers(ICakeContext, string, DotNetFormatSettings) void
Format code to match editorconfig settings for analyzers.
static
DotNetFormatAnalyzers(ICakeContext, string) void
Format code to match editorconfig settings for analyzers.
static
DotNetFormatStyle(ICakeContext, string, DotNetFormatSettings) void
Format code to match editorconfig settings for code style.
static
DotNetFormatStyle(ICakeContext, string) void
Format code to match editorconfig settings for code style.
static
DotNetFormatWhitespace(ICakeContext, string, DotNetFormatSettings) void
Format code to match editorconfig settings for whitespace.
static
DotNetFormatWhitespace(ICakeContext, string) void
Format code to match editorconfig settings for whitespace.
static
DotNetMSBuild(ICakeContext, DotNetMSBuildSettings) void
Builds the specified targets in a project file found in the current working directory.
static
DotNetMSBuild(ICakeContext, string, DotNetMSBuildSettings) void
Builds the specified targets in the project file.
static
DotNetMSBuild(ICakeContext, string) void
Builds the specified targets in the project file.
static
DotNetMSBuild(ICakeContext) void
Builds the specified targets in a project file found in the current working directory.
static
DotNetNuGetAddSource(ICakeContext, string, DotNetNuGetSourceSettings) void
Add the specified NuGet source.
static
DotNetNuGetDelete(ICakeContext, DotNetNuGetDeleteSettings) void
Deletes a package from a server using the specified settings.
static
DotNetNuGetDelete(ICakeContext, string, DotNetNuGetDeleteSettings) void
Deletes a package from a server.
static
DotNetNuGetDelete(ICakeContext, string, string, DotNetNuGetDeleteSettings) void
Deletes a package from a server using the specified settings.
static
DotNetNuGetDelete(ICakeContext, string, string) void
Deletes a specific version of a package from nuget.org.
static
DotNetNuGetDelete(ICakeContext, string) void
Deletes a package from nuget.org.
static
DotNetNuGetDelete(ICakeContext) void
Delete a NuGet Package from a server.
static
DotNetNuGetDisableSource(ICakeContext, string, DotNetNuGetSourceSettings) void
Disable the specified NuGet source.
static
DotNetNuGetDisableSource(ICakeContext, string) void
Disable the specified NuGet source.
static
DotNetNuGetEnableSource(ICakeContext, string, DotNetNuGetSourceSettings) void
Enable the specified NuGet source.
static
DotNetNuGetEnableSource(ICakeContext, string) void
Enable the specified NuGet source.
static
DotNetNuGetHasSource(ICakeContext, string, DotNetNuGetSourceSettings) bool
Determines whether the specified NuGet source exists.
static
DotNetNuGetHasSource(ICakeContext, string) bool
Determines whether the specified NuGet source exists.
static
DotNetNuGetPush(ICakeContext, FilePath, DotNetNuGetPushSettings) void
Pushes one or more packages to a server using the specified settings.
static
DotNetNuGetPush(ICakeContext, FilePath) void
Pushes one or more packages to a server.
static
DotNetNuGetRemoveSource(ICakeContext, string, DotNetNuGetSourceSettings) void
Remove the specified NuGet source.
static
DotNetNuGetRemoveSource(ICakeContext, string) void
Remove the specified NuGet source.
static
DotNetNuGetUpdateSource(ICakeContext, string, DotNetNuGetSourceSettings) void
Update the specified NuGet source.
static
DotNetPack(ICakeContext, string, DotNetPackSettings) void
Package all projects.
static
DotNetPack(ICakeContext, string) void
Package all projects.
static
DotNetPublish(ICakeContext, string, DotNetPublishSettings) void
Publish all projects.
static
DotNetPublish(ICakeContext, string) void
Publish all projects.
static
DotNetRemovePackage(ICakeContext, string, string) void
Removes package reference from a project file.
static
DotNetRemovePackage(ICakeContext, string) void
Removes package reference from a project file.
static
DotNetRestore(ICakeContext, DotNetRestoreSettings) void
Restore all NuGet Packages with the settings.
static
DotNetRestore(ICakeContext, string, DotNetRestoreSettings) void
Restore all NuGet Packages in the specified path with settings.
static
DotNetRestore(ICakeContext, string) void
Restore all NuGet Packages in the specified path.
static
DotNetRestore(ICakeContext) void
Restore all NuGet Packages.
static
DotNetRun(ICakeContext, string, DotNetRunSettings) void
Run project with settings.
static
DotNetRun(ICakeContext, string, ProcessArgumentBuilder, DotNetRunSettings) void
Run project with settings.
static
DotNetRun(ICakeContext, string, ProcessArgumentBuilder) void
Run project with path and arguments.
static
DotNetRun(ICakeContext, string) void
Run project.
static
DotNetRun(ICakeContext) void
Run all projects.
static
DotNetSDKCheck(ICakeContext) void
Lists the latest available version of the .NET SDK and .NET Runtime.
static
DotNetTest(ICakeContext, string, DotNetTestSettings) void
Test project with settings.
static
DotNetTest(ICakeContext, string, ProcessArgumentBuilder, DotNetTestSettings) void
Test project with settings.
static
DotNetTest(ICakeContext, string) void
Test project with path.
static
DotNetTest(ICakeContext) void
Test project.
static
DotNetTool(ICakeContext, FilePath, string, ProcessArgumentBuilder, DotNetToolSettings) void
Execute an .NET Core Extensibility Tool.
static
DotNetTool(ICakeContext, FilePath, string, ProcessArgumentBuilder) void
Execute an .NET Core Extensibility Tool.
static
DotNetTool(ICakeContext, FilePath, string) void
Execute an .NET Core Extensibility Tool.
static
DotNetTool(ICakeContext, string, DotNetToolSettings) void
Execute an .NET Core Extensibility Tool.
static
DotNetTool(ICakeContext, string) void
Execute an .NET Core Extensibility Tool.
static
DotNetVSTest(ICakeContext, GlobPattern, DotNetVSTestSettings) void
Test one or more projects specified by a path or glob pattern with settings using the VS Test host runner.
static
DotNetVSTest(ICakeContext, GlobPattern) void
Test one or more projects specified by a path or glob pattern using the VS Test host runner.
static
DotNetVSTest(ICakeContext, IEnumerable<FilePath>, DotNetVSTestSettings) void
Test one or more specified projects with settings using the VS Test host runner.
static
DotNetWorkloadInstall(ICakeContext, IEnumerable<string>, DotNetWorkloadInstallSettings) void
Installs one or more optional workloads.
static
DotNetWorkloadInstall(ICakeContext, IEnumerable<string>) void
Installs one or more optional workloads.
static
DotNetWorkloadInstall(ICakeContext, string, DotNetWorkloadInstallSettings) void
Installs a specified optional workload.
static
DotNetWorkloadInstall(ICakeContext, string) void
Installs a specified optional workload.
static
DotNetWorkloadList(ICakeContext, DotNetWorkloadListSettings) IEnumerable<DotNetWorkloadListItem>
Lists all installed workloads.
static
DotNetWorkloadList(ICakeContext) IEnumerable<DotNetWorkloadListItem>
Lists all installed workloads.
static
DotNetWorkloadRepair(ICakeContext, DotNetWorkloadRepairSettings) void
Repairs all workloads installations.
static
DotNetWorkloadRepair(ICakeContext) void
Repairs all workloads installations.
static
DotNetWorkloadRestore(ICakeContext, string, DotNetWorkloadRestoreSettings) void
Installs workloads needed for a project or a solution.
static
DotNetWorkloadRestore(ICakeContext, string) void
Installs workloads needed for a project or a solution.
static
DotNetWorkloadSearch(ICakeContext, string, DotNetWorkloadSearchSettings) IEnumerable<DotNetWorkload>
Lists available workloads by specifying all or part of the workload ID.
static
DotNetWorkloadSearch(ICakeContext, string) IEnumerable<DotNetWorkload>
Lists available workloads by specifying all or part of the workload ID.
static
DotNetWorkloadSearch(ICakeContext) IEnumerable<DotNetWorkload>
Lists available workloads.
static
DotNetWorkloadUninstall(ICakeContext, IEnumerable<string>) void
Uninstalls one or more workloads.
static
DotNetWorkloadUninstall(ICakeContext, string) void
Uninstalls a specified workload.
static
DotNetWorkloadUpdate(ICakeContext, DotNetWorkloadUpdateSettings) void
Updates all installed workloads to the newest available version.
static
DotNetWorkloadUpdate(ICakeContext) void
Updates all installed workloads to the newest available version.
static

Extension Methods

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