# libtmux.data/windows

- **Module:** libtmux.data
- **Package:** io.github.libtmux:libtmux-clojure
- **Language:** Clojure
- **Kind:** function
- **Source:** https://github.com/libtmux/libtmux-java/blob/5f88402151ff08fc0390dd438b90963692ec3fe4/libtmux-clojure/src/main/clojure/libtmux/data.clj#L127
- **Public owner:** libtmux.data
- **Page:** https://libtmux.org/en/clojure/latest/reference/libtmux-data-windows/

```
(windows value)
```

Returns the captured window occurrences in a snapshot or session.

Use [[libtmux.core/windows!]] for a new acquisition; [[panes]] stays local.

## Examples

Traverse root and session windows in one captured graph. Use JDK 25 or newer, the Clojure CLI, Git and tmux on Linux or macOS, with /bin/cat and /bin/sh available. These packages are unpublished. In an empty directory, install this exact source into the consumer's isolated Maven repository:

```console
$ git clone https://github.com/libtmux/libtmux-java libtmux-source && \
  git -C libtmux-source checkout --detach 5f88402151ff08fc0390dd438b90963692ec3fe4 && \
  (cd libtmux-source && ./gradlew \
    :libtmux:publishToMavenLocal \
    :libtmux-clojure:publishToMavenLocal \
    --console=plain \
    "-Dmaven.repo.local=$PWD/../m2")
```

Save this file as `deps.edn`. Dependencies resolve from the isolated m2 directory; the core.async dependency is only enabled by its alias.

[Source example](https://github.com/libtmux/libtmux-java/blob/5f88402151ff08fc0390dd438b90963692ec3fe4/examples/api/clojure/deps.edn).

```clojure
{:paths ["src/main/clojure"]
 :mvn/local-repo "m2"
 :deps {org.clojure/clojure {:mvn/version "1.12.6"}
        io.github.libtmux/libtmux-clojure {:mvn/version "0.1.2-SNAPSHOT"}}
 :aliases
 {:core-async
  {:extra-deps
   {io.github.libtmux/libtmux-clojure-core-async {:mvn/version "0.1.2-SNAPSHOT"}}}}}
```

Save this file as `run.sh`. The launcher creates and stops a private server, including after program failure, and reports leaked servers as errors.

[Source example](https://github.com/libtmux/libtmux-java/blob/5f88402151ff08fc0390dd438b90963692ec3fe4/examples/api/run.sh).

```sh
#!/bin/sh
set -eu

if [ "$#" -eq 0 ]; then
    printf 'Usage: sh run.sh program [arguments...]\n' >&2
    exit 2
fi
binary=$(command -v "${TMUX_BIN:-tmux}")
root=${API_RUN_ROOT:-/tmp/libtmux-java-dev}

# A client that names no socket follows TMUX or LIBTMUX_SOCKET*, and otherwise lands on the default
# socket under TMUX_TMPDIR. The program gets none of them, and a TMUX_TMPDIR of its own below.
unset TMUX TMUX_PANE
for name in $(env | sed -n 's/^\(LIBTMUX_SOCKET[A-Za-z0-9_]*\)=.*/\1/p'); do
    unset "$name"
done

mkdir -p "$root"
directory=$(mktemp -d "$root/api.XXXXXX")
tmpdir=$(mktemp -d "$root/tmpdir.XXXXXX")
socket="$directory/tmux.sock"
config="$directory/tmux.conf"

serves() {
    "$binary" -S "$1" display-message -p '#{pid}' >/dev/null 2>&1
}

# Stops the server on the socket, then waits for it to stop answering.
stop() {
    "$binary" -S "$1" kill-server || return 1
    attempts=0
    while serves "$1" && [ "$attempts" -lt 60 ]; do
        sleep 0.05
        attempts=$((attempts + 1))
    done
    ! serves "$1"
}

cleanup() {
    status=$?
    trap - 0 HUP INT TERM PIPE
    # A closed output must not end the cleanup, whose messages are the only thing left to write.
    trap '' PIPE
    set +e
    stuck=
    left=
    if [ -S "$socket" ] && serves "$socket" && ! stop "$socket"; then
        stuck="$stuck tmux.sock"
    fi
    # Every socket anywhere under either directory, without following links. Only one a server answers
    # on is a leak; the runner's own is expected to be there.
    old_ifs=$IFS
    IFS='
'
    set -f
    for candidate in $(find "$tmpdir" "$directory" -type s 2>/dev/null); do
        [ "$candidate" = "$socket" ] && continue
        serves "$candidate" || continue
        case "$candidate" in
            "$tmpdir"/*) name=${candidate#"$tmpdir"/} ;;
            *) name=${candidate#"$directory"/} ;;
        esac
        left="$left $name"
        stop "$candidate" || stuck="$stuck $name"
    done
    set +f
    IFS=$old_ifs
    if [ -n "$stuck" ]; then
        printf 'tmux still answers on%s after kill-server; kept %s and %s under the runner root\n' \
            "$stuck" "${directory##*/}" "${tmpdir##*/}" >&2
        exit 1
    fi
    rm -rf "$directory" "$tmpdir" || exit 1
    if [ -n "$left" ]; then
        printf 'The program left a tmux server running:%s\n' "$left" >&2
        exit 1
    fi
    exit "$status"
}
trap cleanup 0
trap 'exit 1' HUP INT TERM PIPE

# A default socket path longer than this does not fit in sun_path.
default_socket="$tmpdir/tmux-$(id -u)/default"
if [ "$(printf '%s' "$default_socket" | wc -c)" -gt 100 ]; then
    printf 'API_RUN_ROOT is too long for a tmux socket\n' >&2
    exit 1
fi
TMUX_TMPDIR=$tmpdir
export TMUX_TMPDIR

printf 'set-option -g default-shell /bin/sh\n' > "$config"
"$binary" -S "$socket" -f "$config" new-session -d -s work-one -n editor /bin/cat
"$binary" -S "$socket" split-window -h -t '=work-one:editor' /bin/cat
"$binary" -S "$socket" new-window -d -t '=work-one' -n logs /bin/cat
"$binary" -S "$socket" new-session -d -s work-two -n editor /bin/cat
"$@" "$binary" "$socket" "$config"
"$binary" -S "$socket" has-session -t '=work-one'
"$binary" -S "$socket" has-session -t '=work-two'
```

Save the complete program as `src/main/clojure/libtmux/examples/api/list_windows.clj`, creating its parent directories. Closing its client leaves the launcher's server running.

[Source example](https://github.com/libtmux/libtmux-java/blob/5f88402151ff08fc0390dd438b90963692ec3fe4/examples/src/main/clojure/libtmux/examples/api/list_windows.clj).

```clojure
(ns libtmux.examples.api.list-windows
  "Traverse root and session windows from the same captured graph."
  (:require [clojure.string :as str]
            [libtmux.core :as tm]
            [libtmux.data :as data]))

(defn -main [& args]
  (when-not (= 3 (count args))
    (throw (IllegalArgumentException. "expected: tmux-binary socket-path config-file")))
  (let [[binary socket config] args]
    (with-open [server (tm/open! {:binary binary :socket-path socket
                                 :config-file config})]
      (let [snapshot (tm/snapshot! server)
            session (data/exactly-one
                     (filter #(= "work-one" (:session/name %))
                             (:tmux/sessions snapshot)))]
        (println (str "windows="
                      (str/join "," (sort (map :window/name (data/windows snapshot))))))
        (println (str "session-windows="
                      (str/join "," (sort (map :window/name (data/windows session))))))))))
```

Run it with the private fixture. Set TMUX_BIN to select another tmux binary:

```console
$ sh run.sh clojure \
  -J-Dclojure.main.report=stderr \
  -M \
  -m libtmux.examples.api.list-windows
```

Expected output:

```text
windows=editor,editor,logs
session-windows=editor,logs
```

## Parameters

- `value`

## Guides

Pages that discuss `windows`.

- [Server, session, window, pane](/en/clojure/latest/concepts/server-session-window-pane/)

## In other ports

A tmux window

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Window`](/en/py/latest/reference/libtmux-window/) (class) |
| Ruby | [`LibTmux::Window`](/en/ruby/latest/reference/libtmux-window-1vfx/) (class) |
| Lua | [`libtmux.Window`](/en/lua/latest/reference/libtmux-window/) (class) |
| PowerShell | [`LibTmux\Get-TmuxWindow`](/en/powershell/latest/reference/libtmux-get-tmuxwindow/) (cmdlet). This cmdlet reads shared .NET `LibTmux.Window` placements. Use [`-Server`](/en/powershell/latest/reference/libtmux-get-tmuxwindow/#LibTmux%5CGet-TmuxWindow.parameter.Server) for all sessions or [`-Session`](/en/powershell/latest/reference/libtmux-get-tmuxwindow/#LibTmux%5CGet-TmuxWindow.parameter.Session) for one session. |
| Julia | [`LibTmux.WindowSnapshot`](/en/julia/latest/reference/libtmux-windowsnapshot/) (struct). `WindowSnapshot` holds captured physical-window data. `WindowLink` records a placement in a session; actions use `WindowRef`. |
| Erlang | [`#tmux_model:window{}`](/en/erlang/latest/reference/tmux_model-window/) (struct). A physical window can have several session memberships. `window_link` holds the session-relative index and active flag. |
| Elixir | [`LibTmux.Window`](/en/elixir/latest/reference/libtmux-window/) (struct). `Window` is a physical window. `WindowLink` records its session index and active state. |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| Common Lisp | [`libtmux:window`](/en/lisp/latest/reference/libtmux-window-type/) (class). `window` is a physical captured window. `window-link` preserves each session placement. |
| TypeScript | [`window.Window`](/en/ts/latest/reference/window-window/) (class) |
| Rust | [`window.Window`](/en/rs/latest/reference/window-window/) (struct) |
| Go | [`tmux.Window`](/en/go/latest/reference/tmux-window/) (struct) |
| Java | [`io.github.libtmux.Window`](/en/java/latest/reference/io-github-libtmux-window-window/) (class) |
| Kotlin | [`io.github.libtmux.kotlin.Window`](/en/kotlin/latest/reference/io-github-libtmux-kotlin-window/) (class) |
| Scala | [`io.github.libtmux.scaladsl.Window`](/en/scala/latest/reference/io-github-libtmux-scaladsl-window/) (typealias) |
| C# | [`LibTmux.Window`](/en/csharp/latest/reference/libtmux-window/) (class) |
| F# | [`LibTmux.FSharp.Window`](/en/fsharp/latest/reference/libtmux-fsharp-window/) (module). This F# module identifies shared .NET `LibTmux.Window` placements and builds deferred pane queries. `Query.list` acquires their results from tmux. |
| C++ | [`libtmux::Window`](/en/cxx/latest/reference/libtmux-window/) (class) |
| Swift | [`Window`](/en/swift/latest/reference/window/) (struct) |
| OCaml | [`Libtmux.Window.t`](/en/ocaml/latest/reference/libtmux-window-t/) (typealias). A global window can have several session placements. Window_link holds the session, index and current flag. |
| Perl | [`LibTmux::Window`](/en/perl/latest/reference/libtmux-window/) (class). Physical window identity. WindowLink owns each session/index placement. |

List a session's windows

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Session.windows`](/en/py/latest/reference/libtmux-session-windows/) (property) |
| Ruby | [`LibTmux::Session#list_windows`](/en/ruby/latest/reference/libtmux-session-list_windows/) (method) |
| 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. |
| Erlang | [`tmux_snapshot:related/3`](/en/erlang/latest/reference/tmux_snapshot-related-3/) (function). Pass `windows`, a captured session and its snapshot for a local relationship read. |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| Common Lisp | [`libtmux:windows`](/en/lisp/latest/reference/libtmux-windows/) (function). `windows` traverses a captured session. Repeated links preserve their physical-window multiplicity. |
| 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.windows`](/en/java/latest/reference/io-github-libtmux-session-session-windows/) (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) |
| C# | [`LibTmux.Session.Windows`](/en/csharp/latest/reference/libtmux-session-windows/) (property) |
| 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. |
| C++ | [`libtmux::Session::windows`](/en/cxx/latest/reference/libtmux-session-windows/) (method) |
| Swift | [`Snapshot.windows(of:)`](/en/swift/latest/reference/snapshot-windows(of-)/) (method) |
| OCaml | [`Libtmux.Session.windows`](/en/ocaml/latest/reference/libtmux-session-windows/) (function). Reads distinct captured global windows in this session. window_links preserves individual indexed placements. |
| Perl | Traverse Session::window_links and resolve each link’s window, preserving explicit session placement and multiplicity. |

No equivalent is recorded in Lua or Elixir.