# tmux client library for Common Lisp

Source: https://libtmux.org/en/lisp/latest/core/

> tmux client library for Common Lisp. Control tmux, navigate sessions, windows, and panes, send keys, capture pane contents

Control tmux, navigate sessions, windows, and panes, send keys, capture pane contents.

## At a glance

| Type | Wraps |
| ---- | ----- |
| [`libtmux:client`](https://libtmux.org/en/lisp/latest/reference/libtmux-client/) | A tmux server |
| [`libtmux:session`](https://libtmux.org/en/lisp/latest/reference/libtmux-session-type/) | A session, ID `$n` |
| [`libtmux:window`](https://libtmux.org/en/lisp/latest/reference/libtmux-window-type/) | A window in a session, ID `@n` |
| [`libtmux:pane`](https://libtmux.org/en/lisp/latest/reference/libtmux-pane/) | A pane in a window, ID `%n` |

## Typed API

- Typed objects instead of parsed format strings: [`libtmux:snapshot`](https://libtmux.org/en/lisp/latest/reference/libtmux-snapshot/)
- Addressing by tmux ID: [`libtmux:id`](https://libtmux.org/en/lisp/latest/reference/libtmux-id/)
- Filtering and queries over tmux objects: [`libtmux.query:compile-filter`](https://libtmux.org/en/lisp/latest/reference/libtmux-query-compile-filter/)
- Typed errors instead of exit codes and stderr: [`libtmux:libtmux-error`](https://libtmux.org/en/lisp/latest/reference/libtmux-libtmux-error/)

## What you get over the tmux CLI

- Traversal from a server down to its panes: [`libtmux:fetch-snapshot`](https://libtmux.org/en/lisp/latest/reference/libtmux-fetch-snapshot/)
- Send keys to a pane: [`libtmux:send-keys`](https://libtmux.org/en/lisp/latest/reference/libtmux-send-keys/)
- Capture pane contents: [`libtmux:capture-pane`](https://libtmux.org/en/lisp/latest/reference/libtmux-capture-pane/)
- Arguments passed as a list, with no shell quoting: [`libtmux:run-command`](https://libtmux.org/en/lisp/latest/reference/libtmux-run-command/)
- A typed error when the running tmux lacks a feature: [`libtmux:unsupported-capability`](https://libtmux.org/en/lisp/latest/reference/libtmux-unsupported-capability/)

- [Guides](https://libtmux.org/en/lisp/latest/guides/): Install the source checkout, acquire snapshots, and issue explicit operations.
- [Concepts](https://libtmux.org/en/lisp/latest/concepts/): Understand captured identity, transport ownership, and local query behavior.
- [Examples](https://libtmux.org/en/lisp/latest/examples/): Run tested programs against an owned tmux server.
- [API reference](https://libtmux.org/en/lisp/latest/reference/): Browse public packages, CLOS types, conditions, macros, and functions.