Set pane title

set_pane_title

set_pane_title
mutating tool

Set the title of a tmux pane.

Returns:

PaneInfo

Use when you want to label a pane for identification.

Side effects: Changes the pane title.

Example:

{
  "tool": "set_pane_title",
  "arguments": {
    "pane_id": "%0",
    "title": "build"
  }
}

Response:

{
  "pane_id": "%0",
  "pane_index": "0",
  "pane_width": "80",
  "pane_height": "24",
  "pane_current_command": "zsh",
  "pane_current_path": "/home/user/myproject",
  "pane_pid": "12345",
  "pane_title": "build",
  "pane_active": "1",
  "window_id": "@0",
  "session_id": "$0",
  "is_caller": false
}

Parameters

Parameter

Type

Required

Default

Description

title

str

yes

The new pane title.

pane_id

str

no

Pane ID (e.g. ‘%1’).

session_name

str

no

Session name for pane resolution.

session_id

str

no

Session ID (e.g. ‘$1’) for pane resolution.

window_id

str

no

Window ID for pane resolution.

socket_name

str

no

tmux socket name.