Skip to content

pane_send_text

Asynchronously send literal text to a pane without interpreting it as named key input.

Send literal text to a pane.

Parameters:

Name Type Description Default
pane_id str

Target pane identifier.

required
text str

Text to write to the pane.

required

Returns:

Type Description
OkResult

The server's successful command result.

Example
client = AsyncHerdrClient()
await client.pane_send_text("build", "printf 'ready\n'")
Source code in src/herdr_client/async_client/client.py
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
async def pane_send_text(self, pane_id: str, text: str) -> OkResult:
    """Send literal text to a pane.

    Args:
        pane_id: Target pane identifier.
        text: Text to write to the pane.

    Returns:
        The server's successful command result.

    Example:
        ```python
        client = AsyncHerdrClient()
        await client.pane_send_text("build", "printf 'ready\\n'")
        ```
    """
    params: PaneSendTextParams = {"pane_id": pane_id, "text": text}
    return await self.request("pane.send_text", params)