ProjectLaunchArgsOverrideAnnotation

Docs/Reference/Search C# APIs/Aspire.Hosting/ProjectLaunchArgsOverrideAnnotation

ProjectLaunchArgsOverrideAnnotation

Docs Reference Search C# APIs Aspire.Hosting ProjectLaunchArgsOverrideAnnotation

Classsealednet10.0

📦 Aspire.Hosting v13.5.3

Represents an annotation that overrides the default project launch arguments generated by DCP for a ProjectResource.

Experimental — ASPIREPROJECTS001 · Learn more

namespace Aspire.Hosting.ApplicationModel;

public sealed class ProjectLaunchArgsOverrideAnnotation
    : Aspire.Hosting.ApplicationModel.IResourceAnnotation
{
    // ...
}

IResourceAnnotation

Implements

• IResourceAnnotation

Source

Remarks

When this annotation is present on a ProjectResource, DCP will use the provided arguments as the base command (e.g., build /t:Run) instead of the default run verb. DCP still appends the project path positionally and appends --configuration automatically; only the verb and its options are overridden. This annotation is intended for verbs like build that accept the project path as a positional argument. The --no-launch-profile flag is omitted when this annotation is present.

A non-empty launch-tool argument callback replaces this base command. If the callback resolves no arguments, this override remains the Process command.

Constructors1

ProjectLaunchArgsOverrideAnnotation(IReadOnlyList<string>, string?)

Represents an annotation that overrides the default project launch arguments generated by DCP for a ProjectResource.

View all constructors

Properties2

Argumentsget

IReadOnlyList<string>

Gets the custom launch arguments to use instead of the default project args.

LeadingResourceArgumentToRemoveget

string?

Gets the optional first resource argument to omit from the final launch arguments when it is already represented by ProjectLaunchArgsOverrideAnnotation.Arguments.

View all properties

Examples

Override DCP's default launch to use dotnet build /t:Run:

builder.WithAnnotation(new ProjectLaunchArgsOverrideAnnotation(["build", "/t:Run"]));