Rename window

rename_window

rename_window

mutating tool

Rename a tmux window.

Returns:

WindowInfo

Use when a window name no longer reflects its purpose.

Side effects: Renames the window.

Example:

{
  "tool": "rename_window",
  "arguments": {
    "session_name": "dev",
    "new_name": "build"
  }
}

Response:

{
  "window_id": "@0",
  "window_name": "build",
  "window_index": "1",
  "session_id": "$0",
  "session_name": "dev",
  "pane_count": 2,
  "window_layout": "7f9f,80x24,0,0[80x15,0,0,0,80x8,0,16,1]",
  "window_active": "1",
  "window_width": "80",
  "window_height": "24"
}

Parameters

Parameter	Type	Required	Default	Description
new_name	str	yes	—	The new name for the window.
window_id	str	no	—	Window ID (e.g. ‘@1’).
window_index	str	no	—	Window index within the session.
session_name	str	no	—	Session name.
session_id	str	no	—	Session ID.
socket_name	str	no	—	tmux socket name.