# tmux client library for F#

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

> tmux client library for F#. Control tmux, navigate sessions, windows, and panes, send keys, watch for changes via control mode, capture pane contents

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

## At a glance

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

## Typed API

- Filtering and queries over tmux objects: [`LibTmux.FSharp.Query`](https://libtmux.org/en/fsharp/latest/reference/libtmux-fsharp-query/)
- Typed errors instead of exit codes and stderr: [`LibTmux.FSharp.TmuxFailure`](https://libtmux.org/en/fsharp/latest/reference/libtmux-fsharp-tmuxfailure/)

## What you get over the tmux CLI

- Traversal from a server down to its panes: [`LibTmux.FSharp.Server.panes`](https://libtmux.org/en/fsharp/latest/reference/libtmux-fsharp-server-panes/)
- Send keys to a pane: [`LibTmux.FSharp.Pane.sendKeys`](https://libtmux.org/en/fsharp/latest/reference/libtmux-fsharp-pane-sendkeys/)
- Watch for changes through tmux control mode: [`LibTmux.FSharp.Control`](https://libtmux.org/en/fsharp/latest/reference/libtmux-fsharp-control/)
- Capture pane contents: [`LibTmux.FSharp.Pane.capture`](https://libtmux.org/en/fsharp/latest/reference/libtmux-fsharp-pane-capture/)
- Async operations: [`LibTmux.FSharp.Pane.run`](https://libtmux.org/en/fsharp/latest/reference/libtmux-fsharp-pane-run/)

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