Class TerminalHandle

constructor

• new TerminalHandle(
      id: string,
      sessionId: string,
      conn: Connection,
  ): TerminalHandle

  Parameters

  • id: string
  • sessionId: string
  • conn: Connection

  Returns TerminalHandle

id

currentOutput

• currentOutput(): Promise<TerminalOutputResponse>

  Gets the current terminal output without waiting for the command to exit.

  Returns Promise<TerminalOutputResponse>

waitForExit

• waitForExit(): Promise<WaitForTerminalExitResponse>

  Waits for the terminal command to complete and returns its exit status.

  Returns Promise<WaitForTerminalExitResponse>

kill

• kill(): Promise<KillTerminalResponse>

  Kills the terminal command without releasing the terminal.

  The terminal remains valid after killing, allowing you to:

  • Get the final output with currentOutput()
  • Check the exit status
  • Release the terminal when done

  Useful for implementing timeouts or cancellation.

  Returns Promise<KillTerminalResponse>

release

• release(): Promise<void | ReleaseTerminalResponse>

  Releases the terminal and frees all associated resources.

  If the command is still running, it will be killed. After release, the terminal ID becomes invalid and cannot be used with other terminal methods.

  Tool calls that already reference this terminal will continue to display its output.

  Important: Always call this method when done with the terminal.

  Returns Promise<void | ReleaseTerminalResponse>

[asyncDispose]

• "[asyncDispose]"(): Promise<void>

  Returns Promise<void>