Skip to main content

​
Definition

Assembly: CloudNimble.DotNetDocs.Tools.dll Namespace: CloudNimble.DotNetDocs.Tools.Commands Inheritance: CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase

​
Syntax

CloudNimble.DotNetDocs.Tools.Commands.UpdateCommand

​
Summary

Command-line tool for updating existing .docsproj files to use the latest DotNetDocs.Sdk version from NuGet.

​
Remarks

This command searches for all .docsproj files in the current directory (and optionally subdirectories), queries NuGet.org for the latest SDK version, and updates the SDK reference in each file.

​
Constructors

​
.ctor

​
Syntax

public UpdateCommand()

​
Properties

​
ProjectPath

Gets or sets the project name or path to a specific .docsproj file to update.

​
Syntax

public string ProjectPath { get; set; }

​
Property Value

Type: string?

​
Recursive

Gets or sets whether to search recursively in subdirectories.

​
Syntax

public bool Recursive { get; set; }

​
Property Value

Type: bool

​
UsePrerelease

Gets or sets whether to use the latest prerelease version of the DotNetDocs.Sdk.

​
Syntax

public bool UsePrerelease { get; set; }

​
Property Value

Type: bool

​
Methods

​
OnExecute

Executes the command to update .docsproj SDK references to the latest version from NuGet.

​
Syntax

public System.Threading.Tasks.Task<int> OnExecute(McMaster.Extensions.CommandLineUtils.CommandLineApplication app)

​
Parameters

NameTypeDescription
appMcMaster.Extensions.CommandLineUtils.CommandLineApplicationThe command-line application context used to access command-line arguments and configuration.

​
Returns

Type: System.Threading.Tasks.Task<int> A task that represents the asynchronous operation. The task result is 0 if the update is successful; otherwise, 1.

​
Remarks

If a specific project is not specified, the method searches for all .docsproj files in the current directory (and subdirectories if —recursive is specified). The —project option accepts either a project name (e.g., “MyProject.Docs”) or a file path (e.g., “MyProject.Docs.docsproj” or “path/to/MyProject.Docs.docsproj”). Any errors encountered during execution are reported to the console, and a nonzero exit code is returned.