libtmux
Swift

Choose a port 13

Scripting & web

Python RubyUnavailable LuaUnavailable TypeScript

Compiled & native

Rust Go C++ Swift

JVM

Java KotlinUnavailable ScalaUnavailable

.NET

C# F#Unavailable

tmux

tmux CLI

Search
Colour scheme
Menu
Reference MCP
MCPAPI Reference

Choose documentation 3

Swift · latest · en
latest

Current version

latest
English

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

snapshot_pane

Read pane output; accepts no client-supplied executable input. Returned content may be sensitive or untrusted. Return pane metadata and bounded terminal content together.

All Swift tools · JSON · Source

Arguments

maxLines optional · integer
Caller-controlled maxLines.
paneId required · string
Caller-controlled paneId.

Schemas

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

Input schema 
{
  "additionalProperties": false,
  "properties": {
    "maxLines": {
      "description": "Caller-controlled maxLines.",
      "maximum": 2000,
      "minimum": 1,
      "type": "integer"
    },
    "paneId": {
      "description": "Caller-controlled paneId.",
      "type": "string"
    }
  },
  "required": [
    "paneId"
  ],
  "type": "object"
}
Output schema 
{
  "additionalProperties": false,
  "properties": {
    "capture": {
      "additionalProperties": false,
      "properties": {
        "droppedLines": {
          "type": "integer"
        },
        "lines": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "paneId": {
          "type": "string"
        }
      },
      "required": [
        "droppedLines",
        "lines",
        "paneId"
      ],
      "type": "object"
    },
    "pane": {
      "additionalProperties": false,
      "properties": {
        "currentCommand": {
          "type": "string"
        },
        "currentPath": {
          "type": "string"
        },
        "height": {
          "type": "integer"
        },
        "id": {
          "type": "string"
        },
        "index": {
          "type": "integer"
        },
        "isActive": {
          "type": "boolean"
        },
        "isAtBottom": {
          "type": "boolean"
        },
        "isAtLeft": {
          "type": "boolean"
        },
        "isAtRight": {
          "type": "boolean"
        },
        "isAtTop": {
          "type": "boolean"
        },
        "isDead": {
          "type": "boolean"
        },
        "isSynchronized": {
          "type": "boolean"
        },
        "modeCount": {
          "type": "integer"
        },
        "ref": {
          "type": "string"
        },
        "width": {
          "type": "integer"
        },
        "windowID": {
          "type": "string"
        }
      },
      "required": [
        "currentCommand",
        "currentPath",
        "height",
        "id",
        "index",
        "isActive",
        "isAtBottom",
        "isAtLeft",
        "isAtRight",
        "isAtTop",
        "isDead",
        "isSynchronized",
        "modeCount",
        "ref",
        "width",
        "windowID"
      ],
      "type": "object"
    }
  },
  "required": [
    "capture",
    "pane"
  ],
  "type": "object"
}
Tool annotations 
{
  "destructiveHint": true,
  "idempotentHint": false,
  "openWorldHint": true,
  "readOnlyHint": false,
  "title": "Snapshot pane"
}
Esc

Type to search.