# libtmux for F#

> The F# library (LibTmux.FSharp). These pages include its guides, tested examples and API documentation.

## Concepts

- [Concepts](https://libtmux.org/en/fsharp/latest/concepts/): Understand F# handles, filters, transports and layout ownership.
- [Server, session, window, pane](https://libtmux.org/en/fsharp/latest/concepts/server-session-window-pane/): Traverse captured F# handles, retain IDs and refresh after changes.
- [Filtering and queries](https://libtmux.org/en/fsharp/latest/concepts/queries/): Compose F# filters, distinguish zero and several matches, and query captured relations.
- [Commands and control mode](https://libtmux.org/en/fsharp/latest/concepts/transports/): Use F# command calls and persistent control connections with explicit cleanup.
- [Layouts and repeated setup](https://libtmux.org/en/fsharp/latest/concepts/workspaces/): Create and reuse F# tmux layouts while preserving running processes.

## Examples

- [Examples](https://libtmux.org/en/fsharp/latest/examples/): Tested F# examples against an isolated tmux server.
- [Capture pane output](https://libtmux.org/en/fsharp/latest/examples/capture-pane-output/): Run a complete F# program that captures output on an isolated tmux server.

## Guides

- [Guides](https://libtmux.org/en/fsharp/latest/guides/): Guides for LibTmux.FSharp.
- [Getting started](https://libtmux.org/en/fsharp/latest/guides/getting-started/): Create a project and connect to a tmux server.
- [Attaching to tmux](https://libtmux.org/en/fsharp/latest/guides/attaching-to-tmux/): Connect to an existing tmux server and find a session with F#.
- [Quick start](https://libtmux.org/en/fsharp/latest/guides/quickstart/): Install the package, capture server state, and choose a read operation.
- [Querying and filtering](https://libtmux.org/en/fsharp/latest/guides/queries/): List objects, handle missing matches, and filter captured relations.
- [Streams and cleanup](https://libtmux.org/en/fsharp/latest/guides/streams/): Consume events with bounded lifetimes and cancellation.
- [.NET interoperation](https://libtmux.org/en/fsharp/latest/guides/interop/): Use core operations alongside the F# helpers.
- [Execution modes](https://libtmux.org/en/fsharp/latest/guides/modes/): Choose commands, control mode, or bounded concurrent reads.
- [Query fields](https://libtmux.org/en/fsharp/latest/guides/supported-query-fields/): Browse the fields supported by typed filters.

## Reference

- [F# API reference](https://libtmux.org/en/fsharp/latest/reference/): every public symbol, generated from the source. Hosted on libtmux.org.

## Optional

- [Full documentation text](https://libtmux.org/en/fsharp/latest/llms-full.txt): guides and MCP contracts in a single fetch.