Table of Contents

Class DotnetToolInstallOptions

Namespace
Invex.Atom.Module.Dotnet.Cli
Assembly
Invex.Atom.Module.Dotnet.dll
public sealed record DotnetToolInstallOptions
Inheritance
object
DotnetToolInstallOptions

Constructors

DotnetToolInstallOptions()

public DotnetToolInstallOptions()

Properties

AddSource

Add an additional NuGet package source to use during installation.

public string[]? AddSource { get; init; }

Property Value

string[]

AllowDowngrade

Allow package downgrade when installing a .NET tool package.

public bool? AllowDowngrade { get; init; }

Property Value

bool?

AllowRollForward

Allow a .NET tool to roll forward to newer versions of the .NET runtime if the runtime it targets isn't installed.

public bool? AllowRollForward { get; init; }

Property Value

bool?

Arch

The target architecture.

public string? Arch { get; init; }

Property Value

string

ConfigFile

The NuGet configuration file to use.

public string? ConfigFile { get; init; }

Property Value

string

CreateManifestIfNeeded

Create a tool manifest if one isn't found during tool installation. For information on how manifests are located, see https://aka.ms/dotnet/tools/create-manifest-if-needed

public bool? CreateManifestIfNeeded { get; init; }

Property Value

bool?

DisableParallel

Prevent restoring multiple projects in parallel.

public bool? DisableParallel { get; init; }

Property Value

bool?

Framework

The target framework to install the tool for.

public string? Framework { get; init; }

Property Value

string

Global

Install the tool for the current user.

public bool? Global { get; init; }

Property Value

bool?

IgnoreFailedSources

Treat package source failures as warnings.

public bool? IgnoreFailedSources { get; init; }

Property Value

bool?

Interactive

Allows the command to stop and wait for user input or action (for example to complete authentication).

public bool? Interactive { get; init; }

Property Value

bool?

Local

Install the tool and add to the local tool manifest (default).

public bool? Local { get; init; }

Property Value

bool?

NoHttpCache

Do not cache packages and http requests.

public bool? NoHttpCache { get; init; }

Property Value

bool?

Prerelease

Include pre-release packages.

public bool? Prerelease { get; init; }

Property Value

bool?

Source

Replace all NuGet package sources to use during installation with these.

public string[]? Source { get; init; }

Property Value

string[]

ToolManifest

Path to the manifest file.

public string? ToolManifest { get; init; }

Property Value

string

ToolPath

The directory where the tool will be installed. The directory will be created if it does not exist.

public string? ToolPath { get; init; }

Property Value

string

Verbosity

Set the MSBuild verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic].

public VerbosityOptions? Verbosity { get; init; }

Property Value

VerbosityOptions?

Version

The version of the tool package to install.

public string? Version { get; init; }

Property Value

string

Methods

ToArguments()

Converts these options to individual command-line arguments, in schema order.

public IReadOnlyList<string> ToArguments()

Returns

IReadOnlyList<string>

The arguments. Each option name and each value is a separate element, so values need no quoting.