Set environment

set_environment

set_environment
mutating tool

Set a tmux environment variable.

Use when you need to set a tmux environment variable.

Side effects: Sets the variable in the tmux server.

Example:

{
  "tool": "set_environment",
  "arguments": {
    "name": "MY_VAR",
    "value": "hello"
  }
}

Response:

{
  "name": "MY_VAR",
  "value": "hello",
  "status": "set"
}

Parameters

Parameter

Type

Required

Default

Description

name

str

yes

Environment variable name.

value

str

yes

Environment variable value.

session_name

str

no

Session name to set environment for.

session_id

str

no

Session ID to set environment for.

socket_name

str

no

tmux socket name.