Overview
Handle for controlling and monitoring a terminal created via createTerminal.
Provides methods to:
- Get current output without waiting
- Wait for command completion
- Kill the running command
- Release terminal resources
Important: Always call release() when done with the terminal to free resources.
The terminal supports async disposal via Symbol.asyncDispose for automatic cleanup. You can use await using to ensure the terminal is automatically released when it goes out of scope.
Constructor
constructor(
public id: string,
sessionId: string,
conn: Connection
)
AgentSideConnection.createTerminal() instead.
The session ID this terminal belongs to
The underlying connection object
Properties
The unique identifier for this terminal. This ID can be used in ToolCallContent with type “terminal” to embed the terminal in tool calls.
Methods
currentOutput
async currentOutput(): Promise<TerminalOutputResponse>
The current terminal output and exit status (if available)
waitForExit
async waitForExit(): Promise<WaitForTerminalExitResponse>
response
WaitForTerminalExitResponse
The exit status of the terminal command
kill
async kill(): Promise<KillTerminalResponse>
- Get the final output with
currentOutput()
- Check the exit status
- Release the terminal when done
Useful for implementing timeouts or cancellation.
An empty object on success
release
async release(): Promise<ReleaseTerminalResponse | void>
response
ReleaseTerminalResponse | void
An empty object on success
[Symbol.asyncDispose]
async [Symbol.asyncDispose](): Promise<void>
await using syntax for automatic cleanup:
// Terminal is automatically released when it goes out of scope
await using terminal = await connection.createTerminal({
sessionId: 'session-123',
command: 'npm test'
});
const output = await terminal.currentOutput();
// terminal.release() is called automatically at the end of the block
A promise that resolves when the terminal has been released
