Interface IDotnetCli
- Namespace
- Invex.Atom.Module.Dotnet.Cli
- Assembly
- Invex.Atom.Module.Dotnet.dll
Represents the base interface for interacting with the .NET CLI.
public interface IDotnetCli
Remarks
This interface is extended by generated partial interfaces to provide strongly-typed
methods for various .NET CLI commands (e.g., dotnet build, dotnet test).
Methods
Build(RootedPath, DotnetBuildOptions?, ProcessRunOptions?, CancellationToken)
.NET Builder
Task<ProcessRunResult> Build(RootedPath projectOrSolutionOrFile, DotnetBuildOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFileRootedPathThe project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.
optionsDotnetBuildOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Build(string, DotnetBuildOptions?, ProcessRunOptions?, CancellationToken)
.NET Builder
Task<ProcessRunResult> Build(string projectOrSolutionOrFile, DotnetBuildOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFilestringThe project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.
optionsDotnetBuildOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Build(string[], DotnetBuildOptions?, ProcessRunOptions?, CancellationToken)
.NET Builder
Task<ProcessRunResult> Build(string[] projectOrSolutionOrFile, DotnetBuildOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFilestring[]The project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.
optionsDotnetBuildOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
BuildServer(ProcessRunOptions?, CancellationToken)
Interact with servers started from a build.
Task<ProcessRunResult> BuildServer(ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
BuildServerShutdown(DotnetBuildServerShutdownOptions?, ProcessRunOptions?, CancellationToken)
Shuts down build servers that are started from dotnet. By default, all servers are shut down.
Task<ProcessRunResult> BuildServerShutdown(DotnetBuildServerShutdownOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
optionsDotnetBuildServerShutdownOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Clean(RootedPath, DotnetCleanOptions?, ProcessRunOptions?, CancellationToken)
.NET Clean Command
Task<ProcessRunResult> Clean(RootedPath projectOrSolutionOrFile, DotnetCleanOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFileRootedPathThe project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.
optionsDotnetCleanOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Clean(string, DotnetCleanOptions?, ProcessRunOptions?, CancellationToken)
.NET Clean Command
Task<ProcessRunResult> Clean(string projectOrSolutionOrFile, DotnetCleanOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFilestringThe project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.
optionsDotnetCleanOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Clean(string[], DotnetCleanOptions?, ProcessRunOptions?, CancellationToken)
.NET Clean Command
Task<ProcessRunResult> Clean(string[] projectOrSolutionOrFile, DotnetCleanOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFilestring[]The project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.
optionsDotnetCleanOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Completions(ProcessRunOptions?, CancellationToken)
Commands for generating and registering completions for supported shells
Task<ProcessRunResult> Completions(ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Format(string, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> Format(string arguments, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
argumentsstringprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
Format(string[], ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> Format(string[] arguments, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
argumentsstring[]processRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
Fsi(string, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> Fsi(string arguments, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
argumentsstringprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
Fsi(string[], ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> Fsi(string[] arguments, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
argumentsstring[]processRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
MsBuild(string, DotnetMsBuildOptions?, ProcessRunOptions?, CancellationToken)
.NET Builder
Task<ProcessRunResult> MsBuild(string arguments, DotnetMsBuildOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
argumentsstringoptionsDotnetMsBuildOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
MsBuild(string[], DotnetMsBuildOptions?, ProcessRunOptions?, CancellationToken)
.NET Builder
Task<ProcessRunResult> MsBuild(string[] arguments, DotnetMsBuildOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
argumentsstring[]optionsDotnetMsBuildOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
New(string, string[], DotnetNewOptions?, ProcessRunOptions?, CancellationToken)
Template Instantiation Commands for .NET CLI.
Task<ProcessRunResult> New(string templateShortName, string[] templateArgs, DotnetNewOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
templateShortNamestringA short name of the template to create.
templateArgsstring[]Template specific options to use.
optionsDotnetNewOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
NewCreate(string, string[], DotnetNewCreateOptions?, ProcessRunOptions?, CancellationToken)
Instantiates a template with given short name. An alias of 'dotnet new <template name>'.
Task<ProcessRunResult> NewCreate(string templateShortName, string[] templateArgs, DotnetNewCreateOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
templateShortNamestringA short name of the template to create.
templateArgsstring[]Template specific options to use.
optionsDotnetNewCreateOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
NewDetails(string, DotnetNewDetailsOptions?, ProcessRunOptions?, CancellationToken)
Provides the details for specified template package. The command checks if the package is installed locally, if it was not found, it searches the configured NuGet feeds.
Task<ProcessRunResult> NewDetails(string packageIdentifier, DotnetNewDetailsOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packageIdentifierstringPackage identifier
optionsDotnetNewDetailsOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
NewInstall(RootedPath, DotnetNewInstallOptions?, ProcessRunOptions?, CancellationToken)
Installs a template package.
Task<ProcessRunResult> NewInstall(RootedPath package, DotnetNewInstallOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packageRootedPathNuGet package ID or path to folder or NuGet package to install. To install the NuGet package of certain version, use <package ID>::<version>.
optionsDotnetNewInstallOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
NewInstall(string, DotnetNewInstallOptions?, ProcessRunOptions?, CancellationToken)
Installs a template package.
Task<ProcessRunResult> NewInstall(string package, DotnetNewInstallOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packagestringNuGet package ID or path to folder or NuGet package to install. To install the NuGet package of certain version, use <package ID>::<version>.
optionsDotnetNewInstallOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
NewInstall(string[], DotnetNewInstallOptions?, ProcessRunOptions?, CancellationToken)
Installs a template package.
Task<ProcessRunResult> NewInstall(string[] package, DotnetNewInstallOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packagestring[]NuGet package ID or path to folder or NuGet package to install. To install the NuGet package of certain version, use <package ID>::<version>.
optionsDotnetNewInstallOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
NewList(string, DotnetNewListOptions?, ProcessRunOptions?, CancellationToken)
Lists templates containing the specified template name. If no name is specified, lists all templates.
Task<ProcessRunResult> NewList(string templateName, DotnetNewListOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
templateNamestringIf specified, only the templates matching the name will be shown.
optionsDotnetNewListOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
NewSearch(string, DotnetNewSearchOptions?, ProcessRunOptions?, CancellationToken)
Searches for the templates on NuGet.org.
Task<ProcessRunResult> NewSearch(string templateName, DotnetNewSearchOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
templateNamestringIf specified, only the templates matching the name will be shown.
optionsDotnetNewSearchOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
NewUninstall(RootedPath, ProcessRunOptions?, CancellationToken)
Uninstalls a template package.
Task<ProcessRunResult> NewUninstall(RootedPath package, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packageRootedPathNuGet package ID (without version) or path to folder to uninstall. If command is specified without the argument, it lists all the template packages installed.
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
NewUninstall(string, ProcessRunOptions?, CancellationToken)
Uninstalls a template package.
Task<ProcessRunResult> NewUninstall(string package, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packagestringNuGet package ID (without version) or path to folder to uninstall. If command is specified without the argument, it lists all the template packages installed.
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
NewUninstall(string[], ProcessRunOptions?, CancellationToken)
Uninstalls a template package.
Task<ProcessRunResult> NewUninstall(string[] package, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packagestring[]NuGet package ID (without version) or path to folder to uninstall. If command is specified without the argument, it lists all the template packages installed.
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
NewUpdate(DotnetNewUpdateOptions?, ProcessRunOptions?, CancellationToken)
Checks the currently installed template packages for update, and install the updates.
Task<ProcessRunResult> NewUpdate(DotnetNewUpdateOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
optionsDotnetNewUpdateOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Nuget(DotnetNugetOptions?, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> Nuget(DotnetNugetOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
optionsDotnetNugetOptionsprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
NugetDelete(IEnumerable<string>, DotnetNugetDeleteOptions?, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> NugetDelete(IEnumerable<string> packagePaths, DotnetNugetDeleteOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packagePathsIEnumerable<string>optionsDotnetNugetDeleteOptionsprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
NugetLocals(string, DotnetNugetLocalsOptions?, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> NugetLocals(string folders, DotnetNugetLocalsOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
foldersstringoptionsDotnetNugetLocalsOptionsprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
NugetPush(IEnumerable<string>, DotnetNugetPushOptions?, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> NugetPush(IEnumerable<string> packagePaths, DotnetNugetPushOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packagePathsIEnumerable<string>optionsDotnetNugetPushOptionsprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
NugetSign(IEnumerable<string>, DotnetNugetSignOptions?, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> NugetSign(IEnumerable<string> packagePaths, DotnetNugetSignOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packagePathsIEnumerable<string>optionsDotnetNugetSignOptionsprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
NugetTrust(DotnetNugetTrustOptions?, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> NugetTrust(DotnetNugetTrustOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
optionsDotnetNugetTrustOptionsprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
NugetTrustAuthor(string, string, DotnetNugetTrustAuthorOptions?, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> NugetTrustAuthor(string name, string package, DotnetNugetTrustAuthorOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
namestringpackagestringoptionsDotnetNugetTrustAuthorOptionsprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
NugetTrustCertificate(string, string, DotnetNugetTrustCertificateOptions?, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> NugetTrustCertificate(string name, string fingerprint, DotnetNugetTrustCertificateOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
namestringfingerprintstringoptionsDotnetNugetTrustCertificateOptionsprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
NugetTrustList(DotnetNugetTrustListOptions?, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> NugetTrustList(DotnetNugetTrustListOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
optionsDotnetNugetTrustListOptionsprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
NugetTrustRemove(string, DotnetNugetTrustRemoveOptions?, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> NugetTrustRemove(string name, DotnetNugetTrustRemoveOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
namestringoptionsDotnetNugetTrustRemoveOptionsprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
NugetTrustRepository(string, string, DotnetNugetTrustRepositoryOptions?, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> NugetTrustRepository(string name, string package, DotnetNugetTrustRepositoryOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
namestringpackagestringoptionsDotnetNugetTrustRepositoryOptionsprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
NugetTrustSource(string, DotnetNugetTrustSourceOptions?, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> NugetTrustSource(string name, DotnetNugetTrustSourceOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
namestringoptionsDotnetNugetTrustSourceOptionsprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
NugetTrustSync(string, DotnetNugetTrustSyncOptions?, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> NugetTrustSync(string name, DotnetNugetTrustSyncOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
namestringoptionsDotnetNugetTrustSyncOptionsprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
NugetVerify(IEnumerable<string>, DotnetNugetVerifyOptions?, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> NugetVerify(IEnumerable<string> packagePaths, DotnetNugetVerifyOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packagePathsIEnumerable<string>optionsDotnetNugetVerifyOptionsprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
NugetWhy(RootedPath, DotnetNugetWhyOptions?, ProcessRunOptions?, CancellationToken)
Shows the dependency graph for a particular package for a given project or solution.
Task<ProcessRunResult> NugetWhy(RootedPath projectorsolution, DotnetNugetWhyOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectorsolutionRootedPathA path to a project, solution file, or directory.
optionsDotnetNugetWhyOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
NugetWhy(string, string, DotnetNugetWhyOptions?, ProcessRunOptions?, CancellationToken)
Shows the dependency graph for a particular package for a given project or solution.
Task<ProcessRunResult> NugetWhy(string projectorsolution, string package, DotnetNugetWhyOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectorsolutionstringA path to a project, solution file, or directory.
packagestringThe package name to lookup in the dependency graph.
optionsDotnetNugetWhyOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Pack(RootedPath, DotnetPackOptions?, ProcessRunOptions?, CancellationToken)
.NET Core NuGet Package Packer
Task<ProcessRunResult> Pack(RootedPath projectOrSolutionOrFile, DotnetPackOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFileRootedPathThe project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.
optionsDotnetPackOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Pack(string, DotnetPackOptions?, ProcessRunOptions?, CancellationToken)
.NET Core NuGet Package Packer
Task<ProcessRunResult> Pack(string projectOrSolutionOrFile, DotnetPackOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFilestringThe project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.
optionsDotnetPackOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Pack(string[], DotnetPackOptions?, ProcessRunOptions?, CancellationToken)
.NET Core NuGet Package Packer
Task<ProcessRunResult> Pack(string[] projectOrSolutionOrFile, DotnetPackOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFilestring[]The project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.
optionsDotnetPackOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Package(ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> Package(ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
processRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
PackageAdd(string, DotnetPackageAddOptions?, ProcessRunOptions?, CancellationToken)
Add a NuGet package reference to the project.
Task<ProcessRunResult> PackageAdd(string packageId, DotnetPackageAddOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packageIdstringPackage reference in the form of a package identifier like 'Newtonsoft.Json' or package identifier and version separated by '@' like 'Newtonsoft.Json@13.0.3'.
optionsDotnetPackageAddOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
PackageList(DotnetPackageListOptions?, ProcessRunOptions?, CancellationToken)
List all package references of the project or solution.
Task<ProcessRunResult> PackageList(DotnetPackageListOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
optionsDotnetPackageListOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
PackageRemove(string, DotnetPackageRemoveOptions?, ProcessRunOptions?, CancellationToken)
Remove a NuGet package reference from the project.
Task<ProcessRunResult> PackageRemove(string packageName, DotnetPackageRemoveOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packageNamestringThe package reference to remove.
optionsDotnetPackageRemoveOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
PackageRemove(string[], DotnetPackageRemoveOptions?, ProcessRunOptions?, CancellationToken)
Remove a NuGet package reference from the project.
Task<ProcessRunResult> PackageRemove(string[] packageName, DotnetPackageRemoveOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packageNamestring[]The package reference to remove.
optionsDotnetPackageRemoveOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
PackageSearch(string, DotnetPackageSearchOptions?, ProcessRunOptions?, CancellationToken)
Searches one or more package sources for packages that match a search term. If no sources are specified, all sources defined in the NuGet.Config are used.
Task<ProcessRunResult> PackageSearch(string searchTerm, DotnetPackageSearchOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
searchTermstringSearch term to filter package names, descriptions, and tags. Used as a literal value. Example:
dotnet package search some.package. See also--exact-match.optionsDotnetPackageSearchOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
PackageUpdate(IReadOnlyList<string>, DotnetPackageUpdateOptions?, ProcessRunOptions?, CancellationToken)
Update referenced packages in a project or solution.
Task<ProcessRunResult> PackageUpdate(IReadOnlyList<string> packages, DotnetPackageUpdateOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packagesIReadOnlyList<string>Package reference in the form of a package identifier like 'Newtonsoft.Json' or package identifier and version separated by '@' like 'Newtonsoft.Json@13.0.3'.
optionsDotnetPackageUpdateOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Project(ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> Project(ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
processRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
ProjectConvert(RootedPath, DotnetProjectConvertOptions?, ProcessRunOptions?, CancellationToken)
Convert a file-based program to a project-based program.
Task<ProcessRunResult> ProjectConvert(RootedPath file, DotnetProjectConvertOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
fileRootedPathPath to the file-based program.
optionsDotnetProjectConvertOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
ProjectConvert(string, DotnetProjectConvertOptions?, ProcessRunOptions?, CancellationToken)
Convert a file-based program to a project-based program.
Task<ProcessRunResult> ProjectConvert(string file, DotnetProjectConvertOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
filestringPath to the file-based program.
optionsDotnetProjectConvertOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Publish(RootedPath, DotnetPublishOptions?, ProcessRunOptions?, CancellationToken)
Publisher for the .NET Platform
Task<ProcessRunResult> Publish(RootedPath projectOrSolutionOrFile, DotnetPublishOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFileRootedPathThe project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.
optionsDotnetPublishOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Publish(string, DotnetPublishOptions?, ProcessRunOptions?, CancellationToken)
Publisher for the .NET Platform
Task<ProcessRunResult> Publish(string projectOrSolutionOrFile, DotnetPublishOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFilestringThe project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.
optionsDotnetPublishOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Publish(string[], DotnetPublishOptions?, ProcessRunOptions?, CancellationToken)
Publisher for the .NET Platform
Task<ProcessRunResult> Publish(string[] projectOrSolutionOrFile, DotnetPublishOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFilestring[]The project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.
optionsDotnetPublishOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Reference(DotnetReferenceOptions?, ProcessRunOptions?, CancellationToken)
.NET Remove Command
Task<ProcessRunResult> Reference(DotnetReferenceOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
optionsDotnetReferenceOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
ReferenceAdd(IEnumerable<string>, DotnetReferenceAddOptions?, ProcessRunOptions?, CancellationToken)
Add a project-to-project reference to the project.
Task<ProcessRunResult> ReferenceAdd(IEnumerable<string> projectPath, DotnetReferenceAddOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectPathIEnumerable<string>The paths to the projects to add as references.
optionsDotnetReferenceAddOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
ReferenceList(ProcessRunOptions?, CancellationToken)
List all project-to-project references of the project.
Task<ProcessRunResult> ReferenceList(ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
ReferenceRemove(IEnumerable<string>, DotnetReferenceRemoveOptions?, ProcessRunOptions?, CancellationToken)
Remove a project-to-project reference from the project.
Task<ProcessRunResult> ReferenceRemove(IEnumerable<string> projectPath, DotnetReferenceRemoveOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectPathIEnumerable<string>The paths to the referenced projects to remove.
optionsDotnetReferenceRemoveOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Restore(RootedPath, DotnetRestoreOptions?, ProcessRunOptions?, CancellationToken)
.NET dependency restorer
Task<ProcessRunResult> Restore(RootedPath projectOrSolutionOrFile, DotnetRestoreOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFileRootedPathThe project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.
optionsDotnetRestoreOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Restore(string, DotnetRestoreOptions?, ProcessRunOptions?, CancellationToken)
.NET dependency restorer
Task<ProcessRunResult> Restore(string projectOrSolutionOrFile, DotnetRestoreOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFilestringThe project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.
optionsDotnetRestoreOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Restore(string[], DotnetRestoreOptions?, ProcessRunOptions?, CancellationToken)
.NET dependency restorer
Task<ProcessRunResult> Restore(string[] projectOrSolutionOrFile, DotnetRestoreOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFilestring[]The project or solution or C# (file-based program) file to operate on. If a file is not specified, the command will search the current directory for a project or solution.
optionsDotnetRestoreOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Run(RootedPath, DotnetRunOptions?, ProcessRunOptions?, CancellationToken)
.NET Run Command
Task<ProcessRunResult> Run(RootedPath projectOrSolutionOrFile, DotnetRunOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFileRootedPathThe project, solution, or file to operate on.
optionsDotnetRunOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Run(string, DotnetRunOptions?, ProcessRunOptions?, CancellationToken)
.NET Run Command
Task<ProcessRunResult> Run(string projectOrSolutionOrFile, DotnetRunOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFilestringThe project, solution, or file to operate on.
optionsDotnetRunOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Run(string[], string[], DotnetRunOptions?, ProcessRunOptions?, CancellationToken)
.NET Run Command
Task<ProcessRunResult> Run(string[] projectOrSolutionOrFile, string[] applicationArguments, DotnetRunOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFilestring[]The project, solution, or file to operate on.
applicationArgumentsstring[]Arguments passed to the application that is being run.
optionsDotnetRunOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Sdk(ProcessRunOptions?, CancellationToken)
.NET SDK Command
Task<ProcessRunResult> Sdk(ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
SdkCheck(ProcessRunOptions?, CancellationToken)
.NET SDK Check Command
Task<ProcessRunResult> SdkCheck(ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Solution(RootedPath, ProcessRunOptions?, CancellationToken)
.NET modify solution file command
Task<ProcessRunResult> Solution(RootedPath slnFile, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
slnFileRootedPathThe solution file to operate on. If not specified, the command will search the current directory for one.
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Solution(string, ProcessRunOptions?, CancellationToken)
.NET modify solution file command
Task<ProcessRunResult> Solution(string slnFile, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
slnFilestringThe solution file to operate on. If not specified, the command will search the current directory for one.
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
SolutionAdd(IEnumerable<string>, DotnetSolutionAddOptions?, ProcessRunOptions?, CancellationToken)
Add one or more projects to a solution file.
Task<ProcessRunResult> SolutionAdd(IEnumerable<string> projectPath, DotnetSolutionAddOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectPathIEnumerable<string>The paths to the projects to add to the solution.
optionsDotnetSolutionAddOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
SolutionList(DotnetSolutionListOptions?, ProcessRunOptions?, CancellationToken)
List all projects in a solution file.
Task<ProcessRunResult> SolutionList(DotnetSolutionListOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
optionsDotnetSolutionListOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
SolutionMigrate(RootedPath, ProcessRunOptions?, CancellationToken)
Generate a .slnx file from a .sln file.
Task<ProcessRunResult> SolutionMigrate(RootedPath slnFile, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
slnFileRootedPathThe solution file to operate on. If not specified, the command will search the current directory for one.
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
SolutionMigrate(string, ProcessRunOptions?, CancellationToken)
Generate a .slnx file from a .sln file.
Task<ProcessRunResult> SolutionMigrate(string slnFile, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
slnFilestringThe solution file to operate on. If not specified, the command will search the current directory for one.
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
SolutionRemove(IEnumerable<string>, ProcessRunOptions?, CancellationToken)
Remove one or more projects from a solution file.
Task<ProcessRunResult> SolutionRemove(IEnumerable<string> projectPath, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectPathIEnumerable<string>The project paths or names to remove from the solution.
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Store(IEnumerable<string>, DotnetStoreOptions?, ProcessRunOptions?, CancellationToken)
Stores the specified assemblies for the .NET Platform. By default, these will be optimized for the target runtime and framework.
Task<ProcessRunResult> Store(IEnumerable<string> argument, DotnetStoreOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
argumentIEnumerable<string>optionsDotnetStoreOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Test(RootedPath, DotnetTestOptions?, ProcessRunOptions?, CancellationToken)
.NET Test Command for VSTest. To use Microsoft.Testing.Platform, opt-in to the Microsoft.Testing.Platform-based command via global.json. For more information, see https://aka.ms/dotnet-test.
Task<ProcessRunResult> Test(RootedPath projectOrSolutionOrFile, DotnetTestOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFileRootedPathThe project, solution, or file to operate on.
optionsDotnetTestOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Test(string, DotnetTestOptions?, ProcessRunOptions?, CancellationToken)
.NET Test Command for VSTest. To use Microsoft.Testing.Platform, opt-in to the Microsoft.Testing.Platform-based command via global.json. For more information, see https://aka.ms/dotnet-test.
Task<ProcessRunResult> Test(string projectOrSolutionOrFile, DotnetTestOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFilestringThe project, solution, or file to operate on.
optionsDotnetTestOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Test(string[], DotnetTestOptions?, ProcessRunOptions?, CancellationToken)
.NET Test Command for VSTest. To use Microsoft.Testing.Platform, opt-in to the Microsoft.Testing.Platform-based command via global.json. For more information, see https://aka.ms/dotnet-test.
Task<ProcessRunResult> Test(string[] projectOrSolutionOrFile, DotnetTestOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionOrFilestring[]The project, solution, or file to operate on.
optionsDotnetTestOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
Tool(ProcessRunOptions?, CancellationToken)
Install or work with tools that extend the .NET experience.
Task<ProcessRunResult> Tool(ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
ToolExecute(string, IEnumerable<string>, DotnetToolExecuteOptions?, ProcessRunOptions?, CancellationToken)
Executes a tool from source without permanently installing it.
Task<ProcessRunResult> ToolExecute(string packageId, IEnumerable<string> commandArguments, DotnetToolExecuteOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packageIdstringPackage reference in the form of a package identifier like 'dotnetsay' or package identifier and version separated by '@' like 'dotnetsay@2.1.7'.
commandArgumentsIEnumerable<string>Arguments forwarded to the tool
optionsDotnetToolExecuteOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
ToolInstall(string, DotnetToolInstallOptions?, ProcessRunOptions?, CancellationToken)
Install global or local tool. Local tools are added to manifest and restored.
Task<ProcessRunResult> ToolInstall(string packageId, DotnetToolInstallOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packageIdstringPackage reference in the form of a package identifier like 'dotnetsay' or package identifier and version separated by '@' like 'dotnetsay@2.1.7'.
optionsDotnetToolInstallOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
ToolList(string, DotnetToolListOptions?, ProcessRunOptions?, CancellationToken)
List tools installed globally or locally.
Task<ProcessRunResult> ToolList(string packageId, DotnetToolListOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packageIdstringThe NuGet Package Id of the tool to list
optionsDotnetToolListOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
ToolRestore(DotnetToolRestoreOptions?, ProcessRunOptions?, CancellationToken)
Restore tools defined in the local tool manifest.
Task<ProcessRunResult> ToolRestore(DotnetToolRestoreOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
optionsDotnetToolRestoreOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
ToolRun(string, IEnumerable<string>, DotnetToolRunOptions?, ProcessRunOptions?, CancellationToken)
Run a local tool. Note that this command cannot be used to run a global tool.
Task<ProcessRunResult> ToolRun(string commandName, IEnumerable<string> toolArguments, DotnetToolRunOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
commandNamestringThe command name of the tool to run.
toolArgumentsIEnumerable<string>Arguments forwarded to the tool
optionsDotnetToolRunOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
ToolSearch(string, DotnetToolSearchOptions?, ProcessRunOptions?, CancellationToken)
Search dotnet tools in nuget.org
Task<ProcessRunResult> ToolSearch(string searchTerm, DotnetToolSearchOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
searchTermstringSearch term from package id or package description. Require at least one character.
optionsDotnetToolSearchOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
ToolUninstall(string, DotnetToolUninstallOptions?, ProcessRunOptions?, CancellationToken)
Uninstall a global tool or local tool.
Task<ProcessRunResult> ToolUninstall(string packageId, DotnetToolUninstallOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packageIdstringPackage reference
optionsDotnetToolUninstallOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
ToolUpdate(string, DotnetToolUpdateOptions?, ProcessRunOptions?, CancellationToken)
Update a global or local tool.
Task<ProcessRunResult> ToolUpdate(string packageId, DotnetToolUpdateOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
packageIdstringPackage reference in the form of a package identifier like 'dotnetsay' or package identifier and version separated by '@' like 'dotnetsay@2.1.7'.
optionsDotnetToolUpdateOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
VsTest(DotnetVsTestOptions?, ProcessRunOptions?, CancellationToken)
Task<ProcessRunResult> VsTest(DotnetVsTestOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
optionsDotnetVsTestOptionsprocessRunOptionsProcessRunOptionscancellationTokenCancellationToken
Returns
- Task<ProcessRunResult>
Workload(DotnetWorkloadOptions?, ProcessRunOptions?, CancellationToken)
Install or work with workloads that extend the .NET experience.
Task<ProcessRunResult> Workload(DotnetWorkloadOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
optionsDotnetWorkloadOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
WorkloadClean(DotnetWorkloadCleanOptions?, ProcessRunOptions?, CancellationToken)
Removes workload components that may have been left behind from previous updates and uninstallations.
Task<ProcessRunResult> WorkloadClean(DotnetWorkloadCleanOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
optionsDotnetWorkloadCleanOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
WorkloadConfig(DotnetWorkloadConfigOptions?, ProcessRunOptions?, CancellationToken)
Modify or display workload configuration values. To display a value, specify the corresponding command-line option without providing a value. For example: "dotnet workload config --update-mode"
Task<ProcessRunResult> WorkloadConfig(DotnetWorkloadConfigOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
optionsDotnetWorkloadConfigOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
WorkloadHistory(ProcessRunOptions?, CancellationToken)
Shows a history of workload installation actions.
Task<ProcessRunResult> WorkloadHistory(ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
WorkloadInstall(IEnumerable<string>, DotnetWorkloadInstallOptions?, ProcessRunOptions?, CancellationToken)
Install one or more workloads.
Task<ProcessRunResult> WorkloadInstall(IEnumerable<string> workloadId, DotnetWorkloadInstallOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
workloadIdIEnumerable<string>The NuGet package ID of the workload to install.
optionsDotnetWorkloadInstallOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
WorkloadList(DotnetWorkloadListOptions?, ProcessRunOptions?, CancellationToken)
List workloads available.
Task<ProcessRunResult> WorkloadList(DotnetWorkloadListOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
optionsDotnetWorkloadListOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
WorkloadRepair(DotnetWorkloadRepairOptions?, ProcessRunOptions?, CancellationToken)
Repair workload installations.
Task<ProcessRunResult> WorkloadRepair(DotnetWorkloadRepairOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
optionsDotnetWorkloadRepairOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
WorkloadRestore(IEnumerable<string>, DotnetWorkloadRestoreOptions?, ProcessRunOptions?, CancellationToken)
Restore workloads required for a project.
Task<ProcessRunResult> WorkloadRestore(IEnumerable<string> projectOrSolution, DotnetWorkloadRestoreOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
projectOrSolutionIEnumerable<string>The project or solution file to operate on. If a file is not specified, the command will search the current directory for one.
optionsDotnetWorkloadRestoreOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
WorkloadSearch(string, ProcessRunOptions?, CancellationToken)
Search for available workloads.
Task<ProcessRunResult> WorkloadSearch(string searchString, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
searchStringstringThe text to search for in the IDs and descriptions of available workloads.
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
WorkloadSearchVersion(IEnumerable<string>, DotnetWorkloadSearchVersionOptions?, ProcessRunOptions?, CancellationToken)
'dotnet workload search version' has three functions depending on its argument: 1. If no argument is specified, it outputs a list of the latest released workload versions from this feature band. Takes the --take option to specify how many to provide and --format to alter the format. Example: dotnet workload search version --take 2 --format json [{"workloadVersion":"9.0.201"},{"workloadVersion":"9.0.200.1"}] 2. If a workload version is provided as an argument, it outputs a table of various workloads and their versions for the specified workload version. Takes the --format option to alter the output format. Example: dotnet workload search version 9.0.201 Workload manifest ID Manifest feature band Manifest Version ------------------------------------------------------------------------------------------------ microsoft.net.workload.emscripten.current 9.0.100-rc.1 9.0.0-rc.1.24430.3 microsoft.net.workload.emscripten.net6 9.0.100-rc.1 9.0.0-rc.1.24430.3 microsoft.net.workload.emscripten.net7 9.0.100-rc.1 9.0.0-rc.1.24430.3 microsoft.net.workload.emscripten.net8 9.0.100-rc.1 9.0.0-rc.1.24430.3 microsoft.net.sdk.android 9.0.100-rc.1 35.0.0-rc.1.80 microsoft.net.sdk.ios 9.0.100-rc.1 17.5.9270-net9-rc1 microsoft.net.sdk.maccatalyst 9.0.100-rc.1 17.5.9270-net9-rc1 microsoft.net.sdk.macos 9.0.100-rc.1 14.5.9270-net9-rc1 microsoft.net.sdk.maui 9.0.100-rc.1 9.0.0-rc.1.24453.9 microsoft.net.sdk.tvos 9.0.100-rc.1 17.5.9270-net9-rc1 microsoft.net.workload.mono.toolchain.current 9.0.100-rc.1 9.0.0-rc.1.24431.7 microsoft.net.workload.mono.toolchain.net6 9.0.100-rc.1 9.0.0-rc.1.24431.7 microsoft.net.workload.mono.toolchain.net7 9.0.100-rc.1 9.0.0-rc.1.24431.7 microsoft.net.workload.mono.toolchain.net8 9.0.100-rc.1 9.0.0-rc.1.24431.7 3. If one or more workloads are provided along with their versions (by joining them with the '@' character), it outputs workload versions that match the provided versions. Takes the --take option to specify how many to provide and --format to alter the format. Example: dotnet workload search version maui@9.0.0-rc.1.24453.9 ios@17.5.9270-net9-rc1 9.0.201
Task<ProcessRunResult> WorkloadSearchVersion(IEnumerable<string> workloadVersion, DotnetWorkloadSearchVersionOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
workloadVersionIEnumerable<string>Output workload manifest versions associated with the provided workload version.
optionsDotnetWorkloadSearchVersionOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
WorkloadUninstall(IEnumerable<string>, DotnetWorkloadUninstallOptions?, ProcessRunOptions?, CancellationToken)
Uninstall one or more workloads.
Task<ProcessRunResult> WorkloadUninstall(IEnumerable<string> workloadId, DotnetWorkloadUninstallOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
workloadIdIEnumerable<string>The NuGet package ID of the workload to install.
optionsDotnetWorkloadUninstallOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>
WorkloadUpdate(DotnetWorkloadUpdateOptions?, ProcessRunOptions?, CancellationToken)
Update all installed workloads.
Task<ProcessRunResult> WorkloadUpdate(DotnetWorkloadUpdateOptions? options = null, ProcessRunOptions? processRunOptions = null, CancellationToken cancellationToken = default)
Parameters
optionsDotnetWorkloadUpdateOptionsOptions
processRunOptionsProcessRunOptionsProcess run options. NOTE: The name and arguments will be overridden by the appropriate dotnet command
cancellationTokenCancellationTokenCancellation token
Returns
- Task<ProcessRunResult>