Skip to main content
Version: 0.3.0
Last Verified: 2025-01-27
Package: hopx-ai on PyPI

Overview

The Terminal resource provides interactive terminal access via WebSocket. Use this resource when you need interactive shell access, real-time terminal output, or terminal resizing capabilities.
Requires websockets library: pip install websockets

Access

Methods

connect

Connect to interactive terminal.
Parameters:
  • timeout (int, optional): Connection timeout in seconds (default: 30)
Returns: WebSocketClientProtocol - WebSocket connection object Example:

send_input

Send input to terminal.
Parameters:
  • ws (WebSocketClientProtocol): WebSocket connection
  • data (str or bytes): Input data to send
Example:

resize

Resize terminal window.
Parameters:
  • ws (WebSocketClientProtocol): WebSocket connection
  • cols (int): Number of columns
  • rows (int): Number of rows
Example:

iter_output

Iterate over terminal output messages.
Parameters:
  • ws (WebSocketClientProtocol): WebSocket connection
Returns: AsyncIterator[Dict[str, Any]] - Iterator of message dictionaries Example:

Examples

Example 1: Basic Terminal Usage

Example 2: Interactive Terminal Session


See Also

Next Steps