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

list_panes

Inspect tmux metadata; accepts no client-supplied executable input. List tmux panes, optionally within one session or window. Filter for isCaller=true to answer ‘which pane am I in?’, which finds one only when this server drives the caller’s own socket — get_server_info says whose socket that is. This reads sizes and running commands, not terminal text — for that use search_panes.

All .NET tools · JSON · Source

Arguments

session optional · string | null
A session id or name. Omit for every session.

Default: null.

windowId optional · string | null
A window id. Omit for every window.

Default: null.

Schemas

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

Input schema
{
"additionalProperties": false,
"properties": {
"session": {
"default": null,
"description": "A session id or name. Omit for every session.",
"type": [
"string",
"null"
]
},
"windowId": {
"default": null,
"description": "A window id. Omit for every window.",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
Output schema
{
"properties": {
"result": {
"items": {
"properties": {
"active": {
"type": "boolean"
},
"currentCommand": {
"type": [
"string",
"null"
]
},
"currentPath": {
"type": [
"string",
"null"
]
},
"dead": {
"type": "boolean"
},
"height": {
"type": "integer"
},
"historyLimit": {
"type": [
"integer",
"null"
]
},
"historySize": {
"type": [
"integer",
"null"
]
},
"index": {
"type": "integer"
},
"inMode": {
"type": "boolean"
},
"isCaller": {
"type": "boolean"
},
"paneId": {
"type": "string"
},
"pid": {
"type": [
"integer",
"null"
]
},
"sessionId": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"width": {
"type": "integer"
},
"windowId": {
"type": "string"
},
"zoomed": {
"type": "boolean"
}
},
"required": [
"paneId",
"windowId",
"sessionId",
"index",
"width",
"height",
"title",
"active",
"dead",
"zoomed",
"inMode",
"currentCommand",
"currentPath",
"pid",
"historySize",
"historyLimit",
"isCaller"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"result"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "List panes"
}
Esc

Type to search.