Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

paste_text

Put text into a pane through a tmux paste buffer instead of typing it key by key. Use this for anything long or awkward: send_keys types the text, so a shell reading it can react to each character, and a bracketed-paste aware program treats a paste as one block. Optional Enter is appended to that same block. Empty text without Enter is a guarded buffer-free no-op. Paste targets only the named pane, even when synchronized input is enabled. A dead, input-disabled, mode-owned, terminal-attended, or inherited-caller target is refused before setup and again immediately before paste. The private buffer is deleted after setup, refusal, and paste outcomes; observations can still race with tmux. A submitted paste is remembered briefly so wait_for_text can discount its own echo. Send input to a pane’s program; a shell that receives it runs it with your user’s permissions.

All Rust tools · JSON · Source

Arguments

enter optional · boolean
Whether to append Enter to the same paste block.

Default: false.

pane required · string
The `%`-prefixed pane to paste into.
text required · string
The text to deliver.

Schemas

The schema defines required fields, nested values, defaults, and validation constraints.

Input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"enter": {
"default": false,
"description": "Whether to append Enter to the same paste block.",
"type": "boolean"
},
"pane": {
"description": "The `%`-prefixed pane to paste into.",
"type": "string"
},
"text": {
"description": "The text to deliver.",
"type": "string"
}
},
"required": [
"pane",
"text"
],
"type": "object"
}
Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"bytes": {
"description": "How many bytes came from `text`, excluding optional Enter.",
"minimum": 0,
"type": "integer"
},
"pane": {
"description": "The pane it went into.",
"type": "string"
}
},
"required": [
"pane",
"bytes"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Paste Text Into Pane"
}
Esc

Type to search.