# LibTmux::Server::new_session

- **Module:** LibTmux
- **Package:** LibTmux
- **Language:** Perl
- **Kind:** method
- **Source:** https://github.com/libtmux/libtmux-perl/blob/352715a4fa66a96eed7763b90daaa536aa2f121d/packages/core/lib/LibTmux/Server.pm#L989
- **Page:** https://libtmux.org/en/perl/latest/reference/libtmux-server-new_session/

```
sub new_session($self, %args)
```

`new_session(name => string, command => arrayref?, shell_command => string?, width => integer?, height => integer?, cwd => bytes?, environment => hashref?)`.

Create a detached session and return its captured [`LibTmux::Session`](/en/perl/latest/reference/libtmux-session/). command is a literal argument vector; shell_command explicitly requests a shell and is mutually exclusive. Omitting both uses tmux's default command. cwd is path octets; environment supplies NAME/value pairs to the first process. Performs I/O. If creation succeeds but acquisition fails, [`"Creation" in LibTmux::X`](/en/perl/latest/reference/libtmux-x-creation/) retains the known generation-scoped creation receipt and cause.


```perl
    my $session = $server->new_session(name => 'application', command => ['/bin/cat']);
```

## Methods

## Parameters

- `args`

## tmux command

The tmux commands behind `new_session`.

- [`display-message`](/en/tmux/latest/manual/display-message/) (daemon identity or target preflight)
- [`list-clients`](/en/tmux/latest/manual/list-clients/) (after accepted creation)
- [`list-panes`](/en/tmux/latest/manual/list-panes/) `-a` server scope, [`cmd_list_panes_server`](/en/tmux/latest/reference/c-function-cmd-list-panes-c-cmd_list_panes_server/) (after accepted creation) (source: `packages/core/lib/LibTmux/Server.pm:955`)
- [`list-sessions`](/en/tmux/latest/manual/list-sessions/) (after accepted creation)
- [`list-windows`](/en/tmux/latest/manual/list-windows/) `-a` server scope, [`cmd_list_windows_exec`](/en/tmux/latest/reference/c-function-cmd-list-windows-c-cmd_list_windows_exec/) (after accepted creation) (source: `packages/core/lib/LibTmux/Server.pm:955`)
- [`new-session`](/en/tmux/latest/manual/new-session/)

## tmux C API

The C declarations in tmux that implement these commands.

- [`cmd_display_message_entry`](/en/tmux/latest/reference/c-variable-cmd_display_message_entry/) (attribute)
- [`cmd_display_message_exec`](/en/tmux/latest/reference/c-function-cmd-display-message-c-cmd_display_message_exec/) (function)
- [`cmd_list_clients_entry`](/en/tmux/latest/reference/c-variable-cmd_list_clients_entry/) (attribute)
- [`cmd_list_clients_exec`](/en/tmux/latest/reference/c-function-cmd-list-clients-c-cmd_list_clients_exec/) (function)
- [`cmd_list_panes_entry`](/en/tmux/latest/reference/c-variable-cmd_list_panes_entry/) (attribute)
- [`cmd_list_panes_server`](/en/tmux/latest/reference/c-function-cmd-list-panes-c-cmd_list_panes_server/) (function)
- [`cmd_list_sessions_entry`](/en/tmux/latest/reference/c-variable-cmd_list_sessions_entry/) (attribute)
- [`cmd_list_sessions_exec`](/en/tmux/latest/reference/c-function-cmd-list-sessions-c-cmd_list_sessions_exec/) (function)
- [`cmd_list_windows_entry`](/en/tmux/latest/reference/c-variable-cmd_list_windows_entry/) (attribute)
- [`cmd_list_windows_exec`](/en/tmux/latest/reference/c-function-cmd-list-windows-c-cmd_list_windows_exec/) (function)
- [`cmd_new_session_entry`](/en/tmux/latest/reference/c-variable-cmd_new_session_entry/) (attribute)
- [`cmd_new_session_exec`](/en/tmux/latest/reference/c-function-cmd-new-session-c-cmd_new_session_exec/) (function)

Each path starts at a function a command runs, which is degree 1. The degree counts steps from there along the path, and each step is a call or a reference: degree 2 is reached from that function, degree 3 from the next, and so on.

### Create a session and its first pane

1. [`cmd_new_session_exec`](/en/tmux/latest/reference/c-function-cmd-new-session-c-cmd_new_session_exec/) (function)
2. calls → [`spawn_window`](/en/tmux/latest/reference/c-function-spawn_window/) (function)
3. calls → [`spawn_pane`](/en/tmux/latest/reference/c-function-spawn_pane/) (function)
4. calls → [`window_add_pane`](/en/tmux/latest/reference/c-function-window_add_pane/) (function)
5. calls → [`window_pane_create`](/en/tmux/latest/reference/c-function-window-c-window_pane_create/) (function)

## In other ports

Create a session

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Server.new_session`](/en/py/latest/reference/libtmux-server-new_session/) (method) |
| Ruby | [`LibTmux::Server#new_session`](/en/ruby/latest/reference/libtmux-server-new_session/) (method) |
| Lua | [`libtmux.Server:new_session`](/en/lua/latest/reference/libtmux-server-new_session/) (method) |
| Erlang | [`tmux_session:create/2`](/en/erlang/latest/reference/tmux_session-create-2/) (function) |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | [`server.Server.newSession`](/en/ts/latest/reference/server-server-newsession/) (method) |
| Rust | [`server.Server.new_session`](/en/rs/latest/reference/server-server-new_session/) (method) |
| Go | [`tmux.Server.NewSession`](/en/go/latest/reference/tmux-server-newsession/) (method) |
| Java | [`io.github.libtmux.Server.newSession`](/en/java/latest/reference/io-github-libtmux-server-server-newsession/) (method) |
| Clojure | [`libtmux.core/new-session!`](/en/clojure/latest/reference/libtmux-core-new-session/) (function) |
| Kotlin | [`io.github.libtmux.kotlin.Server.newSession`](/en/kotlin/latest/reference/io-github-libtmux-kotlin-server-newsession/) (method) |
| Scala | [`io.github.libtmux.scaladsl.Server.newSession`](/en/scala/latest/reference/io-github-libtmux-scaladsl-server-newsession/) (method) |
| C# | [`LibTmux.Server.CreateSessionAsync`](/en/csharp/latest/reference/libtmux-server-createsessionasync/) (method) |
| C++ | [`libtmux::Server::new_session`](/en/cxx/latest/reference/libtmux-server-new_session/) (method) |
| Swift | [`Server.newSession(named:startDirectory:windowName:width:height:environment:shell:)`](/en/swift/latest/reference/server-newsession(named-startdirectory-windowname-width-height-)/) (method) |
| OCaml | [`Libtmux_unix.Client.create_session`](/en/ocaml/latest/reference/libtmux_unix-client-create_session/) (function) |

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