MCPAPI Reference

Choose documentation 3

latest

Current version

latest
English

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

select_layout

Rearrange a window’s panes using a saved tmux layout or a named layout and its unique abbreviation. Names follow the running daemon’s version; mirrored main layouts require tmux 3.5. Invalid syntax is refused before window lookup. Return the saved layout tmux actually applied. Change tmux state; no client-supplied executable input.

All Rust tools · JSON · Source

Arguments

layout required · string
A saved tmux layout, or a named layout and its unique abbreviation. The names are `even-horizontal`, `even-vertical`, `main-horizontal`, `main-vertical` and `tiled`. The running daemon determines which names and abbreviations are supported; mirrored main layouts require tmux 3.5.
window required · string
The `@`-prefixed window to arrange.

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": {
"layout": {
"description": "A saved tmux layout, or a named layout and its unique abbreviation.\n\nThe names are `even-horizontal`, `even-vertical`, `main-horizontal`,\n`main-vertical` and `tiled`. The running daemon determines which names\nand abbreviations are supported; mirrored main layouts require tmux 3.5.",
"type": "string"
},
"window": {
"description": "The `@`-prefixed window to arrange.",
"type": "string"
}
},
"required": [
"window",
"layout"
],
"type": "object"
}
Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"layout": {
"description": "The layout it now has, in tmux's own syntax.",
"type": "string"
},
"window": {
"description": "The window that was arranged.",
"type": "string"
}
},
"required": [
"window",
"layout"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": false,
"title": "Arrange Window Panes"
}
Esc

Type to search.