DotNet aliases

Built-In

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.

Build

DotNetBuild(string, DotNetBuildSettings) Build all projects.
DotNetBuild(string) Build all projects.

Build Server

DotNetBuildServerShutdown(DotNetBuildServerShutdownSettings) Shuts down build servers that are started from dotnet.
DotNetBuildServerShutdown() Shuts down build servers that are started from dotnet.

Clean

DotNetClean(string, DotNetCleanSettings) Cleans a project's output.
DotNetClean(string) Cleans a project's output.

Execute

DotNetExecute(FilePath, ProcessArgumentBuilder, DotNetExecuteSettings) Execute an assembly with arguments in the specific path with settings.
DotNetExecute(FilePath, ProcessArgumentBuilder) Execute an assembly with arguments in the specific path.
DotNetExecute(FilePath) Execute an assembly.

Format

DotNetFormat(string, DotNetFormatSettings) Formats code to match editorconfig settings.
DotNetFormat(string) Formats code to match editorconfig settings.
DotNetFormatAnalyzers(string, DotNetFormatSettings) Format code to match editorconfig settings for analyzers.
DotNetFormatAnalyzers(string) Format code to match editorconfig settings for analyzers.
DotNetFormatStyle(string, DotNetFormatSettings) Format code to match editorconfig settings for code style.
DotNetFormatStyle(string) Format code to match editorconfig settings for code style.
DotNetFormatWhitespace(string, DotNetFormatSettings) Format code to match editorconfig settings for whitespace.
DotNetFormatWhitespace(string) Format code to match editorconfig settings for whitespace.

MSBuild

DotNetMSBuild(DotNetMSBuildSettings, Action<IEnumerable<string>>) Builds the specified targets in a project file found in the current working directory.
DotNetMSBuild(DotNetMSBuildSettings) Builds the specified targets in a project file found in the current working directory.
DotNetMSBuild(string, DotNetMSBuildSettings, Action<IEnumerable<string>>) Builds the specified targets in the project file.
DotNetMSBuild(string, DotNetMSBuildSettings) Builds the specified targets in the project file.
DotNetMSBuild(string) Builds the specified targets in the project file.
DotNetMSBuild() Builds the specified targets in a project file found in the current working directory.

NuGet

DotNetNuGetAddSource(string, DotNetNuGetSourceSettings) Add the specified NuGet source.
DotNetNuGetDelete(DotNetNuGetDeleteSettings) Deletes a package from a server using the specified settings.
DotNetNuGetDelete(string, DotNetNuGetDeleteSettings) Deletes a package from a server.
DotNetNuGetDelete(string, string, DotNetNuGetDeleteSettings) Deletes a package from a server using the specified settings.
DotNetNuGetDelete(string, string) Deletes a specific version of a package from nuget.org.
DotNetNuGetDelete(string) Deletes a package from nuget.org.
DotNetNuGetDelete() Delete a NuGet Package from a server.
DotNetNuGetDisableSource(string, DotNetNuGetSourceSettings) Disable the specified NuGet source.
DotNetNuGetDisableSource(string) Disable the specified NuGet source.
DotNetNuGetEnableSource(string, DotNetNuGetSourceSettings) Enable the specified NuGet source.
DotNetNuGetEnableSource(string) Enable the specified NuGet source.
DotNetNuGetHasSource(string, DotNetNuGetSourceSettings) Determines whether the specified NuGet source exists.
DotNetNuGetHasSource(string) Determines whether the specified NuGet source exists.
DotNetNuGetLocalsClear(DotNetNuGetLocalsFolder, DotNetNuGetLocalsSettings) Clears local NuGet cache folders.
DotNetNuGetLocalsClear(DotNetNuGetLocalsFolder) Clears local NuGet cache folders.
DotNetNuGetLocalsList(DotNetNuGetLocalsFolder, DotNetNuGetLocalsSettings) Lists local NuGet cache folders.
DotNetNuGetLocalsList(DotNetNuGetLocalsFolder) Lists local NuGet cache folders.
DotNetNuGetPush(FilePath, DotNetNuGetPushSettings) Pushes one or more packages to a server using the specified settings.
DotNetNuGetPush(FilePath) Pushes one or more packages to a server.
DotNetNuGetRemoveSource(string, DotNetNuGetSourceSettings) Remove the specified NuGet source.
DotNetNuGetRemoveSource(string) Remove the specified NuGet source.
DotNetNuGetUpdateSource(string, DotNetNuGetSourceSettings) Update the specified NuGet source.
DotNetNuGetWhy(string, DotNetNuGetWhySettings) Shows why a package is in the restore graph.
DotNetNuGetWhy(string, string, DotNetNuGetWhySettings) Shows why a package is in the restore graph.
DotNetNuGetWhy(string, string) Shows why a package is in the restore graph.
DotNetNuGetWhy(string) Shows why a package is in the restore graph.

Pack

DotNetPack(string, DotNetPackSettings) Package all projects.
DotNetPack(string) Package all projects.

Package

DotNetAddPackage(string, DotNetPackageAddSettings) Adds or updates a package reference in a project file.
DotNetAddPackage(string, string, DotNetPackageAddSettings) Adds or updates a package reference in a project file.
DotNetAddPackage(string, string) Adds or updates a package reference in a project file.
DotNetAddPackage(string) Adds or updates a package reference in a project file.
DotNetDownloadPackage(IEnumerable<string>, DirectoryPath) Downloads NuGet packages to the specified directory without changing project references.
DotNetDownloadPackage(IEnumerable<string>, DotNetPackageDownloadSettings) Downloads NuGet packages to disk without changing project references.
DotNetDownloadPackage(string, DirectoryPath) Downloads a NuGet package to the specified directory without changing project references.
DotNetDownloadPackage(string, DotNetPackageDownloadSettings) Downloads a NuGet package to disk without changing project references.
DotNetDownloadPackage(string) Downloads a NuGet package to disk without changing project references.
DotNetListPackage(string, DotNetPackageListSettings) Lists the package references for a project or solution.
DotNetListPackage(string) Lists the package references for a project or solution.
DotNetListPackage() Lists the package references for a project or solution.
DotNetRemovePackage(string, string, DotNetPackageRemoveSettings) Removes package reference from a project file.
DotNetRemovePackage(string, string) Removes package reference from a project file.
DotNetRemovePackage(string) Removes package reference from a project file.
DotNetSearchPackage(DotNetPackageSearchSettings) List packages on available from source using specified settings.
DotNetSearchPackage(string, DotNetPackageSearchSettings) List packages on available from source using specified settings.
DotNetSearchPackage(string) List packages on available from source using specified settings.
DotNetUpdatePackage(DotNetPackageUpdateSettings) Updates referenced packages in a project.
DotNetUpdatePackage(IEnumerable<string>, DotNetPackageUpdateSettings) Updates package references in a project.
DotNetUpdatePackage(IEnumerable<string>, string, DotNetPackageUpdateSettings) Updates package references in a project.
DotNetUpdatePackage(IEnumerable<string>, string) Updates package references in a project.
DotNetUpdatePackage(IEnumerable<string>) Updates package references in a project.
DotNetUpdatePackage(string, DotNetPackageUpdateSettings) Updates a package reference in a project.
DotNetUpdatePackage(string, string, DotNetPackageUpdateSettings) Updates a package reference in a project.
DotNetUpdatePackage(string, string) Updates a package reference in a project.
DotNetUpdatePackage(string) Updates a package reference in a project.
DotNetUpdatePackage() Updates referenced packages in a project.

Project

DotNetProjectConvert(FilePath, DotNetProjectConvertSettings) Converts a file-based program to a project-based program.
DotNetProjectConvert(FilePath) Converts a file-based program to a project-based program.

Publish

DotNetPublish(string, DotNetPublishSettings) Publish all projects.
DotNetPublish(string) Publish all projects.

Reference

DotNetAddReference(IEnumerable<FilePath>, DotNetReferenceAddSettings) Adds project-to-project (P2P) references.
DotNetAddReference(IEnumerable<FilePath>) Adds project-to-project (P2P) references.
DotNetAddReference(string, IEnumerable<FilePath>, DotNetReferenceAddSettings) Adds project-to-project (P2P) references.
DotNetAddReference(string, IEnumerable<FilePath>) Adds project-to-project (P2P) references.
DotNetListReference(string, DotNetReferenceListSettings) Lists project-to-project references.
DotNetListReference(string) Lists project-to-project references.
DotNetListReference() Lists project-to-project references.
DotNetRemoveReference(IEnumerable<FilePath>, DotNetReferenceRemoveSettings) Removes project-to-project (P2P) references.
DotNetRemoveReference(IEnumerable<FilePath>) Removes project-to-project (P2P) references.
DotNetRemoveReference(string, IEnumerable<FilePath>, DotNetReferenceRemoveSettings) Removes project-to-project (P2P) references.
DotNetRemoveReference(string, IEnumerable<FilePath>) Removes project-to-project (P2P) references.

Restore

DotNetRestore(DotNetRestoreSettings) Restore all NuGet Packages with the settings.
DotNetRestore(string, DotNetRestoreSettings) Restore all NuGet Packages in the specified path with settings.
DotNetRestore(string) Restore all NuGet Packages in the specified path.
DotNetRestore() Restore all NuGet Packages.

Run

DotNetRun(string, DotNetRunSettings) Run project with settings.
DotNetRun(string, ProcessArgumentBuilder, DotNetRunSettings) Run project with settings.
DotNetRun(string, ProcessArgumentBuilder) Run project with path and arguments.
DotNetRun(string) Run project.
DotNetRun() Run all projects.
DotNetRunCode(ProcessStandardInput, DotNetRunSettings) Run C# source from standard input with settings.
DotNetRunCode(ProcessStandardInput, ProcessArgumentBuilder, DotNetRunSettings) Run C# source from standard input with arguments and settings.
DotNetRunCode(ProcessStandardInput, ProcessArgumentBuilder) Run C# source from standard input with arguments.
DotNetRunCode(ProcessStandardInput) Run C# source from standard input.

SDK

DotNetSDKCheck() Lists the latest available version of the .NET SDK and .NET Runtime.

Sln

DotNetSlnAdd(FilePath, IEnumerable<FilePath>, DotNetSlnAddSettings) Adds one or more projects to the solution file.
DotNetSlnAdd(FilePath, IEnumerable<FilePath>) Adds one or more projects to the solution file.
DotNetSlnAdd(IEnumerable<FilePath>, DotNetSlnAddSettings) Adds one or more projects to the solution file.
DotNetSlnAdd(IEnumerable<FilePath>) Adds one or more projects to the solution file.
DotNetSlnList(FilePath, DotNetSlnListSettings) Lists all projects in a solution file.
DotNetSlnList(FilePath) Lists all projects in a solution file.
DotNetSlnList() Lists all projects in a solution file.
DotNetSlnMigrate(FilePath, DotNetSlnMigrateSettings) Generates a .slnx file from the specified .sln file.
DotNetSlnMigrate(FilePath) Generates a .slnx file from the specified .sln file.
DotNetSlnMigrate() Generates a .slnx file from a .sln file in the current directory.
DotNetSlnRemove(FilePath, IEnumerable<FilePath>, DotNetSlnRemoveSettings) Removes a project or multiple projects from the solution file.
DotNetSlnRemove(FilePath, IEnumerable<FilePath>) Removes a project or multiple projects from the solution file.
DotNetSlnRemove(IEnumerable<FilePath>) Removes a project or multiple projects from the solution file.

Test

DotNetTest(string, DotNetTestSettings) Test project with settings.
DotNetTest(string, ProcessArgumentBuilder, DotNetTestSettings) Test project with settings.
DotNetTest(string) Test project with path.
DotNetTest() Test project.
DotNetVSTest(GlobPattern, DotNetVSTestSettings) Test one or more projects specified by a path or glob pattern with settings using the VS Test host runner.
DotNetVSTest(GlobPattern) Test one or more projects specified by a path or glob pattern using the VS Test host runner.
DotNetVSTest(IEnumerable<FilePath>, DotNetVSTestSettings) Test one or more specified projects with settings using the VS Test host runner.

Tool

DotNetTool(FilePath, string, ProcessArgumentBuilder, DotNetToolSettings) Execute an .NET Core Extensibility Tool.
DotNetTool(FilePath, string, ProcessArgumentBuilder) Execute an .NET Core Extensibility Tool.
DotNetTool(FilePath, string) Execute an .NET Core Extensibility Tool.
DotNetTool(string, DotNetToolSettings) Execute an .NET Core Extensibility Tool.
DotNetTool(string) Execute an .NET Core Extensibility Tool.
DotNetToolExecute(string, DotNetToolExecuteSettings) Executes a .NET tool package with dotnet tool exec.
DotNetToolExecute(string, ProcessArgumentBuilder, DotNetToolExecuteSettings) Executes a .NET tool package with dotnet tool exec.
DotNetToolExecute(string, ProcessArgumentBuilder) Executes a .NET tool package with dotnet tool exec.
DotNetToolExecute(string) Executes a .NET tool package with dotnet tool exec.
DotNetToolInstall(string, DotNetToolInstallSettings) Installs a .NET tool package with dotnet tool install.
DotNetToolInstall(string) Installs a .NET tool package with dotnet tool install.
DotNetToolList(DotNetToolListSettings) Lists .NET tools with dotnet tool list.
DotNetToolList(string, DotNetToolListSettings) Lists a .NET tool package with dotnet tool list.
DotNetToolList(string) Lists a .NET tool package with dotnet tool list.
DotNetToolList() Lists .NET tools with dotnet tool list.
DotNetToolRestore(DotNetToolRestoreSettings) Restores .NET tools with dotnet tool restore.
DotNetToolRestore() Restores .NET tools with dotnet tool restore.
DotNetToolRun(string, DotNetToolRunSettings) Runs a local .NET tool with dotnet tool run.
DotNetToolRun(string, ProcessArgumentBuilder, DotNetToolRunSettings) Runs a local .NET tool with dotnet tool run.
DotNetToolRun(string, ProcessArgumentBuilder) Runs a local .NET tool with dotnet tool run.
DotNetToolRun(string) Runs a local .NET tool with dotnet tool run.
DotNetToolSearch(string, DotNetToolSearchSettings) Searches for .NET tool packages with dotnet tool search.
DotNetToolSearch(string) Searches for .NET tool packages with dotnet tool search.
DotNetToolUninstall(string, DotNetToolUninstallSettings) Uninstalls a .NET tool package with dotnet tool uninstall.
DotNetToolUninstall(string) Uninstalls a .NET tool package with dotnet tool uninstall.
DotNetToolUpdate(DotNetToolUpdateSettings) Updates .NET tool packages with dotnet tool update.
DotNetToolUpdate(string, DotNetToolUpdateSettings) Updates a .NET tool package with dotnet tool update.
DotNetToolUpdate(string) Updates a .NET tool package with dotnet tool update.
DotNetToolUpdate() Updates .NET tool packages with dotnet tool update.

Workload

DotNetWorkloadInstall(IEnumerable<string>, DotNetWorkloadInstallSettings) Installs one or more optional workloads.
DotNetWorkloadInstall(IEnumerable<string>) Installs one or more optional workloads.
DotNetWorkloadInstall(string, DotNetWorkloadInstallSettings) Installs a specified optional workload.
DotNetWorkloadInstall(string) Installs a specified optional workload.
DotNetWorkloadList(DotNetWorkloadListSettings) Lists all installed workloads.
DotNetWorkloadList() Lists all installed workloads.
DotNetWorkloadRepair(DotNetWorkloadRepairSettings) Repairs all workloads installations.
DotNetWorkloadRepair() Repairs all workloads installations.
DotNetWorkloadRestore(string, DotNetWorkloadRestoreSettings) Installs workloads needed for a project or a solution.
DotNetWorkloadRestore(string) Installs workloads needed for a project or a solution.
DotNetWorkloadSearch(string, DotNetWorkloadSearchSettings) Lists available workloads by specifying all or part of the workload ID.
DotNetWorkloadSearch(string) Lists available workloads by specifying all or part of the workload ID.
DotNetWorkloadSearch() Lists available workloads.
DotNetWorkloadUninstall(IEnumerable<string>) Uninstalls one or more workloads.
DotNetWorkloadUninstall(string) Uninstalls a specified workload.
DotNetWorkloadUpdate(DotNetWorkloadUpdateSettings) Updates all installed workloads to the newest available version.
DotNetWorkloadUpdate() Updates all installed workloads to the newest available version.