libtmux_mcp.tools.env_tools.set_environment

API reference · Markdown

libtmux_mcp.tools.env_tools.set_environment ( name : str , value : str , session_name : str | None = None , session_id : str | None = None , socket_name : str | None = None ) → EnvironmentSetResult

function [source] ¶

function [source] ¶

libtmux_mcp.tools.env_tools.set_environment

Set a tmux environment variable.

Use to set variables that will be inherited by new panes and windows. Changes do not affect already-running processes.

Some variables control later shell execution. Bash sources the file named by BASH_ENV, POSIX shells may source the file named by ENV, and Bash evaluates PROMPT_COMMAND before displaying a prompt.

Parameters

• name ( str ) – Environment variable name.

• value ( str ) – Environment variable value.

• session_name ( str | None ) – Session name to set environment for.

• session_id ( str | None ) – Session ID to set environment for.

• socket_name ( str | None ) – tmux socket name.

Returns

EnvironmentSetResult Confirmation with variable name, value, and status.