# tmux_session:rename/2

- **Package:** libtmux_erlang
- **Language:** Erlang
- **Kind:** function
- **Source:** https://github.com/libtmux/libtmux-erlang/blob/d1b6308440cf9eb8f6647e7ae434bce60e849368/apps/libtmux_erlang/src/tmux_session.erl#L72
- **Page:** https://libtmux.org/en/erlang/latest/reference/tmux_session-rename-2/

```
rename(Session, Name)
-spec rename(tmux_model:session(), binary()) ->
                {ok, map()} | {error, map()}.
```

Rename the registered session using a literal name and return the command result. Performs I/O. Previously captured records keep their old names; detached or stale references fail validation before the action.

## Parameters

- `Session` (`tmux_model:session()`)
- `Name` (`binary()`)

## tmux command

The tmux commands behind `rename/2`.

- [`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)

## Guides

Pages that discuss `rename/2`.

- [Build commands before running them](/en/erlang/latest/guides/commands/)

## 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) |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | [`session.Session.rename`](/en/ts/latest/reference/session-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) |
| OCaml | [`Libtmux_unix.Client.rename_session`](/en/ocaml/latest/reference/libtmux_unix-client-rename_session/) (function) |
| Perl | [`LibTmux::Server::rename_session`](/en/perl/latest/reference/libtmux-server-rename_session/) (method). Explicit Server operation. Captured entities remain local observations; use a new snapshot to observe changes. |

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