AspireTerminal

Classsealednet10.0

📦 Aspire.Hosting v13.6.0

An Aspire-owned terminal handle for dashboard interaction and automation from AppHost code.

namespace Aspire.Hosting.ApplicationModel;

public sealed class AspireTerminal
    : System.IAsyncDisposable
{
    // ...
}

IAsyncDisposable

11 members

Remarks

Obtain a handle from TerminalService.CreateTerminal or TerminalService.TryGetTerminal. Handles cannot be constructed or extended by callers; Aspire manages their registration and connection to the underlying terminal implementation.

What disposal means depends on AspireTerminal.Owner. For TerminalOwner.AppHost the AppHost owns the workload, so disposing stops it and removes the terminal from the dashboard; whoever creates such a terminal owns it and must dispose it, and showing one in an interaction does not transfer that ownership, so the terminal survives the dialog it was displayed in. For TerminalOwner.Resource the workload belongs to the resource, so disposing only releases Aspire's handle and leaves the workload running.

When an AppHost-owned workload ends, its terminal remains in the dashboard until disposed, but no longer accepts input or automation. Reopening an ended terminal displays its ended state rather than replaying output.

Properties4

Idget

string

Gets the opaque identifier used to address this terminal over the dashboard connection.

Ownerget

TerminalOwner

Gets the process that owns this terminal's workload.

Placementget

TerminalPlacement

Gets where this terminal is displayed in the dashboard.

Titleget

string

Gets the title shown on the terminal's dock tab.

View all properties

Methods7

DisposeAsync

ValueTask

Releases the handle, stopping the workload only when it is owned by the AppHost.

GetScreenText

string

Gets the current contents of the terminal screen, with lines separated by newlines.

SendKeyAsync(AspireTerminalKey, CancellationToken)

Task

Sends a single key, optionally combined with modifiers, to the terminal's workload.

SendTextAsync(string, CancellationToken)

Task

Sends text to the terminal's workload as though it had been typed.

Show

Reveals the terminal dock in every connected dashboard and switches to this terminal's tab.

Start

Starts the terminal's workload if it is not already running.

WaitForTextAsync(string, TimeSpan?, CancellationToken)

Task

Waits until text appears on the terminal screen.

View all methods