# LibTmux::Server#new_session

- **Module:** LibTmux
- **Package:** libtmux
- **Language:** Ruby
- **Kind:** method
- **Source:** https://github.com/libtmux/libtmux-ruby/blob/dcc9f8b5a6970144a9e7d80cd5f381d8f6198372/gems/libtmux/lib/libtmux/server.rb#L252
- **Page:** https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/libtmux-server-new_session/

tmux command: [`new-session`](/en/tmux/latest/manual/new-session/)

```
def new_session: (
  name: ::String,
  command: ::Array[::String],
  receipt: true,
  ?width: ::Integer?,
  ?height: ::Integer?,
  ?window_name: ::String?,
  ?cwd: ::String?,
  ?environment: ::Hash[::String, ::String],
  ?timeout: ::Numeric,
  ?cancel: untyped
) -> ::LibTmux::CreationReceipt

def new_session: (
  name: ::String,
  command: ::Array[::String],
  ?receipt: false,
  ?width: ::Integer?,
  ?height: ::Integer?,
  ?window_name: ::String?,
  ?cwd: ::String?,
  ?environment: ::Hash[::String, ::String],
  ?timeout: ::Numeric,
  ?cancel: untyped
) -> ::LibTmux::Session
```

Behavior: Creation.

Behavior contract: Creation.

## Examples

Start a private server and create a session. Request a creation receipt to read the session, window, and pane IDs returned by that creation command. Use Ruby 4.0.7, Bundler, Git and tmux 3.2a or newer on Unix, with /bin/cat and /bin/sh available. In an empty directory, fetch the documented library revision:

```console
$ git clone https://github.com/libtmux/libtmux-ruby.git libtmux-source && \
  git -C libtmux-source checkout dcc9f8b5a6970144a9e7d80cd5f381d8f6198372
```

Save this dependency file as Gemfile:

```ruby
source "https://rubygems.org"

gem "libtmux", path: "libtmux-source/gems/libtmux"
```

Save this complete program as new_session.rb. Its Server.start block owns a private tmux server and stops it on exit, including after an error.

[Source example](https://github.com/libtmux/libtmux-ruby/blob/dcc9f8b5a6970144a9e7d80cd5f381d8f6198372/examples/api/new_session.rb).

```ruby
# frozen_string_literal: true

require "libtmux"

begin
  LibTmux::Server.start do |server|
    created = server.new_session(
      name: "work", window_name: "main", command: ["/bin/cat"], receipt: true
    )
    puts "session: #{created.entity.id}"
    puts "window: #{created.window.id}"
    puts "pane: #{created.pane.id}"
  end
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end
```

Install the runtime dependencies and run the saved program. An operation or cleanup error makes it exit unsuccessfully:

```console
$ bundle config set --local path vendor/bundle && \
  bundle install --jobs 2 && \
  bundle exec ruby new_session.rb
```

Expected output:

```text
session: $0
window: @0
pane: %0
```

## In other ports

### Create a session

- Python: [`libtmux.Server.new_session`](/en/py/latest/reference/libtmux-server-new_session/) (method)
- Lua: [`libtmux.Server:new_session`](/en/lua/latest/reference/libtmux-server-new_session/) (method)
- 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.Server.newSession`](/en/java/latest/reference/io-github-libtmux-server-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:)`](/en/swift/latest/reference/server-newsession(named-startdirectory-windowname-width-height-)/) (method)
- 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)