libtmux_mcp.tools.option_tools.set_option
-
Set a tmux option value.
Description#
Some option values are executable. tmux runs a
#(...)job inside the status formats when it draws them, and repeats it on the status interval;default-commandanddefault-shelldecide what every future pane runs, andcommand-aliasrewrites later commands. The value is stored verbatim, so an option that interprets it later runs what is stored, not what this call did.Use to change tmux behavior at runtime. Common uses: adjusting history-limit, enabling mouse support, changing status bar format.
- Parameters
-
-
scope(t.Literal ["server", "session", "window", "pane"] | None) # – Option scope. -
target(str | None) # – Target identifier. For session scope: session name (e.g. 'mysession'). For window scope: window ID (e.g. '@1'). For pane scope: pane ID (e.g. '%1'). Requires scope. -
socket_name(str | None) # – tmux socket name.
- Returns
-
OptionSetResult Confirmation with option name, value, and status.