# LibTmux::Session#list_windows

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

tmux command: [`list-windows`](/en/tmux/latest/manual/list-windows/)

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

Behavior: Live acquisition.

Behavior contract: Live acquisition.

## Examples

List all server windows and the windows belonging to one session. 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 list_windows.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/list_windows.rb).

```ruby
# frozen_string_literal: true

require "libtmux"

begin
  LibTmux::Server.start do |server|
    work = server.new_session(name: "work", command: ["/bin/cat"])
    work.new_window(name: "logs", command: ["/bin/cat"])
    server.new_session(name: "other", command: ["/bin/cat"])
    puts "server windows: #{server.list_windows.length}"
    puts "work windows: #{work.list_windows.length}"
  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 list_windows.rb
```

Expected output:

```text
server windows: 3
work windows: 2
```

## In other ports

### List a session's windows

- PowerShell: [`LibTmux\Get-TmuxWindow`](/en/powershell/latest/reference/libtmux-get-tmuxwindow/) (cmdlet). Use the [`-Session`](/en/powershell/latest/reference/libtmux-get-tmuxwindow/#LibTmux%5CGet-TmuxWindow.parameter.Session) parameter set to acquire placements in one session.
- Julia: [`LibTmux.windows`](/en/julia/latest/reference/libtmux-windows/) (function). `windows` with a captured `SessionSnapshot` reads distinct physical windows in that session. Use `windowlinks` for placements.
- Python: [`libtmux.Session.windows`](/en/py/latest/reference/libtmux-session-windows/) (property)
- TypeScript: [`session.Session.windows`](/en/ts/latest/reference/session-session-windows/) (method)
- Rust: [`session.Session.windows`](/en/rs/latest/reference/session-session-windows/) (method)
- Go: [`tmux.Session.Windows`](/en/go/latest/reference/tmux-session-windows/) (method)
- Java: [`io.github.libtmux.Session.Session.windows`](/en/java/latest/reference/io-github-libtmux-session-session-windows/) (method)
- C#: [`LibTmux.Session.Windows`](/en/csharp/latest/reference/libtmux-session-windows/) (property)
- C++: [`libtmux::Session::windows`](/en/cxx/latest/reference/libtmux-session-windows/) (method)
- Swift: [`Snapshot.windows(of:)`](/en/swift/latest/reference/snapshot-windows(of-)/) (method)
- Kotlin: [`io.github.libtmux.kotlin.Session.windows`](/en/kotlin/latest/reference/io-github-libtmux-kotlin-session-windows/) (property)
- Scala: [`io.github.libtmux.scaladsl.Session.windows`](/en/scala/latest/reference/io-github-libtmux-scaladsl-session-windows/) (method)
- F#: [`LibTmux.FSharp.Session.windows`](/en/fsharp/latest/reference/libtmux-fsharp-session-windows/) (function). Builds a deferred window query from one `LibTmux.Session` and its server. `Query.list` acquires placements scoped to that session ID.
