RuntimeSpec

Docs / Reference / Search C# APIs / Aspire.TypeSystem / RuntimeSpec

RuntimeSpec

Docs Reference Search C# APIs Aspire.TypeSystem RuntimeSpec

Class sealed net8.0

📦 Aspire.TypeSystem v13.4.0

Specifies the runtime execution configuration for a language.

namespace Aspire.TypeSystem;

public sealed class RuntimeSpec
{
    // ...
}

Source

Search members of RuntimeSpec...

constructor property

13 members Clear filters

Constructors1

RuntimeSpec

View all constructors

Properties12

CodeGenLanguageget; init

string

Gets the code generation language identifier for the generateCode RPC.

DetectionPatternsget; init

string[]

Gets the file patterns used to detect this language (e.g., ["apphost.ts"]).

DisplayNameget; init

string

Gets the display name for the language (e.g., "TypeScript (Node.js)").

Executeget; init

CommandSpec

Gets the command to execute the AppHost for run.

ExtensionLaunchCapabilityget; init

string?

Gets the extension capability required to launch this language via the VS Code extension. When set (e.g., "node"), the CLI will use the extension launcher if the extension reports this capability. When null, the CLI always uses the default process-based launcher.

Initializeget; init

CommandSpec[]?

Gets the commands to initialize the project environment (e.g., create a virtual environment and install dependencies). Runs once during scaffolding. Null if no initialization is needed.

InstallDependenciesget; init

CommandSpec?

Gets the command to install dependencies. Null if no dependencies to install.

Languageget; init

string

Gets the language identifier (e.g., "TypeScript", "Python").

MigrationFilesget; init

Dictionary<string, string>

Gets files that must exist in the project directory before execution. If a file in this dictionary is missing, the CLI will create it with the provided content. This supports upgrade scenarios where new runtime requirements are introduced.

PreExecuteget; init

CommandSpec[]?

Gets the commands to run before executing or publishing the AppHost. Null if no pre-execution validation is needed. Watch-mode validation should be part of RuntimeSpec.WatchExecute when needed.

PublishExecuteget; init

CommandSpec?

Gets the command to execute the AppHost for publish. Null to use Execute with args appended.

WatchExecuteget; init

CommandSpec?

Gets the command to execute the AppHost in watch mode. Null if watch mode not supported.

View all properties