# session.Session.rename

- **Module:** session
- **Package:** libtmux
- **Language:** TypeScript
- **Kind:** method
- **Source:** https://github.com/libtmux/libtmux-ts/blob/073b9d7dedad900bff6f5ec0ea47794e40225870/packages/libtmux/src/session.ts#L426
- **Page:** https://libtmux.org/en/ts/latest/reference/session-session-rename/

```
rename(name: string): Promise<void>
```

Rename this session.

Refuses a name the supported servers would not store identically.

## Examples

```ts
await session.rename("renamed");
```

## Parameters

- `name` (`string`)

## tmux command

The tmux commands behind `rename`.

- [`rename-session`](/en/tmux/latest/manual/rename-session/)

## tmux C API

The C declarations in tmux that implement these commands.

- [`cmd_rename_session_entry`](/en/tmux/latest/reference/c-variable-cmd_rename_session_entry/) (attribute)
- [`cmd_rename_session_exec`](/en/tmux/latest/reference/c-function-cmd-rename-session-c-cmd_rename_session_exec/) (function)

## In other ports

Rename a session

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Session.rename_session`](/en/py/latest/reference/libtmux-session-rename_session/) (method) |
| Ruby | [`LibTmux::Session#rename`](/en/ruby/latest/reference/libtmux-session-rename/) (method) |
| Lua | [`libtmux.Session:rename`](/en/lua/latest/reference/libtmux-session-rename/) (method) |
| Rust | [`session.Session.rename`](/en/rs/latest/reference/session-session-rename/) (method) |
| Go | [`tmux.Session.Rename`](/en/go/latest/reference/tmux-session-rename/) (method) |
| Java | [`io.github.libtmux.Session.rename`](/en/java/latest/reference/io-github-libtmux-session-session-rename/) (method) |
| C# | [`LibTmux.Session.RenameAsync`](/en/csharp/latest/reference/libtmux-session-renameasync/) (method) |
| C++ | [`libtmux::Session::rename`](/en/cxx/latest/reference/libtmux-session-rename/) (method) |
| Swift | [`Server.rename(_:to:)`](/en/swift/latest/reference/server-rename(_-to-)/) (method) |

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