TypeScript

Choose a port 16

Scripting & web

JuliaNo matching page

Compiled & native

JVM

KotlinNo matching page

ScalaNo matching page

.NET

F#No matching page

PowerShellNo matching page

BEAM

ElixirNo matching page

tmux

Packages

Packages and source 9

Source

libtmuxpackages/libtmux libtmux-tslibtmux/libtmux-ts @libtmux/mcppackages/mcp @libtmux/workspacepackages/workspace @libtmux/workspace-clipackages/workspace-cli

Packages

libtmuxnpm @libtmux/mcpnpm @libtmux/workspacenpm @libtmux/workspace-clinpm

TypeScript · libtmux/libtmux-ts

Auto Light Dark

Core Library0.xAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

0.x Released; the API may change. Read more

MCP Tools for connected assistants

Home Guides Topics Examples Tools Prompts Resources API Reference

concept Working example; may change without notice. Read more

Workspace Manager Repeatable development environments

Home Guides Examples CLI Manual API Reference Configuration Internals

concept Working example; may change without notice. Read more

latest

Current version

English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

TypeScript API

method libtmux-ts latest

Session.rename

Rename this session.

Source and package

Qualified name: Session.rename
Module: session
Declared in: Session
Package: libtmux
Source: packages/libtmux/src/session.ts
Other languages: PowerShell Julia Elixir PythonRubyLuaRustGoJavaC#C++Swift Kotlin Scala F#

rename(name: string): Promise<void> method [source] ¶

Description#

Refuses a name the supported servers would not store identically.

Examples#

await session.rename("renamed");

Parameters

name (string) #

tmux command#

The tmux commands behind rename.

rename-session

tmux C API#

The C declarations in tmux that implement these commands.

cmd_rename_session_entry cmd_rename_session_exec

In other ports#

Rename a session

Equivalents of Rename a session in other languages
Language	Equivalent
Python	`libtmux.Session.rename_session`
Ruby	`LibTmux::Session#rename`
Lua	`libtmux.Session:rename`
Rust	`session.Session.rename`
Go	`tmux.Session.Rename`
Java	`io.github.libtmux.Session.rename`
C#	`LibTmux.Session.RenameAsync`
C++	`libtmux::Session::rename`
Swift	`Server.rename(_:to:)`

No equivalent is recorded in PowerShell, Julia, Elixir, Kotlin, Scala or F#.

Reference preview