Rename session

rename_session

rename_session
mutating tool

Rename a tmux session.

Returns:

SessionInfo

Use when a session name no longer reflects its purpose.

Side effects: Renames the session. Existing references by old name will break.

Example:

{
  "tool": "rename_session",
  "arguments": {
    "session_name": "old-name",
    "new_name": "new-name"
  }
}

Response:

{
  "session_id": "$0",
  "session_name": "new-name",
  "window_count": 2,
  "session_attached": "0",
  "session_created": "1774521871"
}

Parameters

Parameter

Type

Required

Default

Description

new_name

str

yes

New name for the session.

session_name

str

no

Current session name to look up.

session_id

str

no

Session ID (e.g. ‘$1’) to look up.

socket_name

str

no

tmux socket name. Defaults to LIBTMUX_SOCKET env var.