# tmux client library for Kotlin

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

> tmux client library for Kotlin. Control tmux, connect to and create servers, navigate sessions, windows, and panes, send keys, watch for changes via control mode, capture pane contents

Control tmux, connect to and create servers, navigate sessions, windows, and panes, send keys, watch for changes via control mode, capture pane contents.

## At a glance

| Type | Wraps |
| ---- | ----- |
| [`io.github.libtmux.kotlin.Server`](https://libtmux.org/en/kotlin/latest/reference/io-github-libtmux-kotlin-server/) | A tmux server |
| [`io.github.libtmux.kotlin.Session`](https://libtmux.org/en/kotlin/latest/reference/io-github-libtmux-kotlin-session/) | A session, ID `$n` |
| [`io.github.libtmux.kotlin.Window`](https://libtmux.org/en/kotlin/latest/reference/io-github-libtmux-kotlin-window/) | A window in a session, ID `@n` |
| [`io.github.libtmux.kotlin.Pane`](https://libtmux.org/en/kotlin/latest/reference/io-github-libtmux-kotlin-pane/) | A pane in a window, ID `%n` |

## Typed API

- Typed objects instead of parsed format strings: [`io.github.libtmux.kotlin.Pane`](https://libtmux.org/en/kotlin/latest/reference/io-github-libtmux-kotlin-pane/)
- Addressing by tmux ID: [`io.github.libtmux.kotlin.Pane.id`](https://libtmux.org/en/kotlin/latest/reference/io-github-libtmux-kotlin-pane-id/)
- Filtering and queries over tmux objects: [`io.github.libtmux.kotlin.Iterable.filter`](https://libtmux.org/en/kotlin/latest/reference/io-github-libtmux-kotlin-iterable-filter/)

## What you get over the tmux CLI

- Connect to or start a tmux server: [`io.github.libtmux.kotlin.Server.Companion.open`](https://libtmux.org/en/kotlin/latest/reference/io-github-libtmux-kotlin-server-companion-open/)
- Traversal from a server down to its panes: [`io.github.libtmux.kotlin.Server.panes`](https://libtmux.org/en/kotlin/latest/reference/io-github-libtmux-kotlin-server-panes/)
- Send keys to a pane: [`io.github.libtmux.kotlin.Pane.sendKeys`](https://libtmux.org/en/kotlin/latest/reference/io-github-libtmux-kotlin-pane-sendkeys/)
- Watch for changes through tmux control mode: [`io.github.libtmux.kotlin.ControlClient`](https://libtmux.org/en/kotlin/latest/reference/io-github-libtmux-kotlin-controlclient/)
- Capture pane contents: [`io.github.libtmux.kotlin.Pane.capture`](https://libtmux.org/en/kotlin/latest/reference/io-github-libtmux-kotlin-pane-capture/)
- Arguments passed as a list, with no shell quoting: [`io.github.libtmux.kotlin.Server.cmd`](https://libtmux.org/en/kotlin/latest/reference/io-github-libtmux-kotlin-server-cmd/)
- Async operations: [`io.github.libtmux.kotlin.Server.panes`](https://libtmux.org/en/kotlin/latest/reference/io-github-libtmux-kotlin-server-panes/)

- [Guides](https://libtmux.org/en/kotlin/latest/guides/): Task guides for Kotlin.
- [Examples](https://libtmux.org/en/kotlin/latest/examples/): Complete programs, sourced from the code each port tests.
- [API reference](https://libtmux.org/en/kotlin/latest/reference/): Types and functions of the Kotlin API.