# LibTmux::Server#list_sessions

- **Module:** LibTmux
- **Package:** libtmux
- **Language:** Ruby
- **Kind:** method
- **Source:** https://github.com/libtmux/libtmux-ruby/blob/da7b6191b9439e3c84fa1c9eeaa9168263ee7af4/gems/libtmux/lib/libtmux/server.rb#L266
- **Page:** https://libtmux.org/en/ruby/v0.1.1/reference/libtmux-server-list_sessions/

```
def list_sessions: (
  ?timeout: ::Numeric,
  ?cancel: untyped
) -> ::Array[::LibTmux::Session]
```

Behavior: Live acquisition.

Behavior contract: Live acquisition.

## Examples

List live session handles from a server containing two sessions. Use Ruby 3.3 or newer with Bundler, and tmux 3.3a or newer, on Unix with `/bin/cat` and `/bin/sh` available. In an empty directory, save this `Gemfile`:

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

gem "libtmux", "0.1.1"
```

Save this complete program as `list_sessions.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/da7b6191b9439e3c84fa1c9eeaa9168263ee7af4/examples/api/list_sessions.rb).

```ruby
# frozen_string_literal: true

begin
  # docs:begin main
  require "libtmux"

  LibTmux::Server.start do |server|
    server.new_session(name: "work", command: ["/bin/cat"])
    server.new_session(name: "logs", command: ["/bin/cat"])
    sessions = server.list_sessions
    puts "sessions: #{sessions.map(&:id).sort.join(', ')}"
  end
  # docs:end main
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end
```

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

```console
$ bundle install && \
  bundle exec ruby list_sessions.rb
```

Expected output:

```text
sessions: $0, $1
```

## Parameters

- `timeout` (`::Numeric`)
- `cancel` (`untyped`)

## tmux command

The tmux commands behind `list_sessions`.

- [`list-sessions`](/en/tmux/latest/manual/list-sessions/)

## tmux C API

The C declarations in tmux that implement these commands.

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

## In other ports

List the server’s sessions

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Server.sessions`](/en/py/latest/reference/libtmux-server-sessions/) (property) |
| Lua | [`libtmux.Snapshot.sessions`](/en/lua/latest/reference/libtmux-snapshot-sessions/) (attribute) |
| PowerShell | [`LibTmux\Get-TmuxSession`](/en/powershell/latest/reference/libtmux-get-tmuxsession/) (cmdlet). Acquires sessions through [`-Server`](/en/powershell/latest/reference/libtmux-get-tmuxsession/#LibTmux%5CGet-TmuxSession.parameter.Server), with optional exact [`-Id`](/en/powershell/latest/reference/libtmux-get-tmuxsession/#LibTmux%5CGet-TmuxSession.parameter.Id) and [`-Name`](/en/powershell/latest/reference/libtmux-get-tmuxsession/#LibTmux%5CGet-TmuxSession.parameter.Name) selectors. |
| Julia | [`LibTmux.sessions`](/en/julia/latest/reference/libtmux-sessions/) (function). `sessions` reads membership from a captured `Snapshot` without contacting tmux. |
| Elixir | [`LibTmux.Snapshot.sessions/1`](/en/elixir/latest/reference/libtmux-snapshot-sessions-1/) (function). Returns a `Selection` of captured sessions without contacting tmux. |
| TypeScript | [`server.Server.sessions`](/en/ts/latest/reference/server-server-sessions/) (method) |
| Rust | [`server.Server.sessions`](/en/rs/latest/reference/server-server-sessions/) (method) |
| Go | [`tmux.Server.Sessions`](/en/go/latest/reference/tmux-server-sessions/) (method) |
| Java | [`io.github.libtmux.Server.sessions`](/en/java/latest/reference/io-github-libtmux-server-server-sessions/) (method) |
| Kotlin | [`io.github.libtmux.kotlin.Server.sessions`](/en/kotlin/latest/reference/io-github-libtmux-kotlin-server-sessions/) (method) |
| Scala | [`io.github.libtmux.scaladsl.Server.sessions`](/en/scala/latest/reference/io-github-libtmux-scaladsl-server-sessions/) (method) |
| C# | [`LibTmux.Server.Sessions`](/en/csharp/latest/reference/libtmux-server-sessions/) (property) |
| F# | [`LibTmux.FSharp.Server.sessions`](/en/fsharp/latest/reference/libtmux-fsharp-server-sessions/) (function). Builds a deferred session query on `LibTmux.Server`. `Query.list` acquires the results; it does not traverse the handle’s captured membership. |
| C++ | [`libtmux::Server::sessions`](/en/cxx/latest/reference/libtmux-server-sessions/) (method) |
| Swift | [`Server.sessions()`](/en/swift/latest/reference/server-sessions()/) (method) |