# libtmux for OCaml

> The OCaml library (libtmux). These pages include its guides, tested examples and API documentation.

## Concepts

- [OCaml concepts](https://libtmux.org/en/ocaml/latest/concepts/): Understand immutable observations, window links and typed queries.

## Core

- [tmux client library for OCaml](https://libtmux.org/en/ocaml/latest/core/): tmux client library for OCaml. Control tmux, connect to and create servers, navigate sessions, windows, and panes, send keys, watch for changes via control mode, capture pane contents

## Examples

- [OCaml examples](https://libtmux.org/en/ocaml/latest/examples/): Run complete native OCaml programs against an isolated tmux server.

## Guides

- [Guides](https://libtmux.org/en/ocaml/latest/guides/): Guides for libtmux.
- [Install and run your first capture](https://libtmux.org/en/ocaml/latest/guides/getting-started/): Install and run your first capture: libtmux documentation.
- [Start a private tmux server from OCaml](https://libtmux.org/en/ocaml/latest/guides/bootstrap/): Start a private tmux server from OCaml: libtmux documentation.
- [Sessions, window links and panes](https://libtmux.org/en/ocaml/latest/guides/graph/): Sessions, window links and panes: libtmux documentation.
- [Query captured data](https://libtmux.org/en/ocaml/latest/guides/queries/): Query captured data: libtmux documentation.
- [Share a scalar pane query](https://libtmux.org/en/ocaml/latest/guides/query-interchange/): Share a scalar pane query: libtmux documentation.
- [Submit actions and retain their outcomes](https://libtmux.org/en/ocaml/latest/guides/control/): Submit actions and retain their outcomes: libtmux documentation.
- [Recover an operation after cancelling its waiter](https://libtmux.org/en/ocaml/latest/guides/recovery/): Recover an operation after cancelling its waiter: libtmux documentation.
- [Observe output and wait for rendered text](https://libtmux.org/en/ocaml/latest/guides/streaming/): Observe output and wait for rendered text: libtmux documentation.
- [Run a complete capability example](https://libtmux.org/en/ocaml/latest/guides/showcases/): Run a complete capability example: libtmux documentation.
- [Choose the packages your application needs](https://libtmux.org/en/ocaml/latest/guides/packages/): Choose the packages your application needs: libtmux documentation.
- [Compatibility](https://libtmux.org/en/ocaml/latest/guides/compatibility/): Compatibility: libtmux documentation.
- [Testing and CI](https://libtmux.org/en/ocaml/latest/guides/testing/): Testing and CI: libtmux documentation.
- [Measure capture, concurrency and output delivery](https://libtmux.org/en/ocaml/latest/guides/benchmarking/): Measure capture, concurrency and output delivery: libtmux documentation.
- [Current capabilities and adoption gaps](https://libtmux.org/en/ocaml/latest/guides/status/): Current capabilities and adoption gaps: libtmux documentation.

## Linking and consuming our docs

- [Linking and consuming our docs](https://libtmux.org/en/ocaml/latest/meta/linking/): Find documentation exports for search engines, bots, LLMs and other documentation sites.
- [Link to libtmux from Sphinx](https://libtmux.org/en/ocaml/latest/meta/intersphinx/): Use Intersphinx inventories to reference libtmux APIs and documentation.
- [Intersphinx examples](https://libtmux.org/en/ocaml/latest/meta/intersphinx/examples/): Compare Sphinx and MyST references to APIs, tmux C declarations, hooks, format variables, CLI commands and schema fields.

## Meta

- [AI policy](https://libtmux.org/en/ocaml/latest/meta/ai-policy/): Use the libtmux packages with AI tools. When contributing, check what you submit and wait for a maintainer's invitation before preparing a pull request.
- [Third-party notices](https://libtmux.org/en/ocaml/latest/meta/third-party-notices/): Thanks to tmux's creator and contributors, with licences and attribution for the software behind libtmux.org.

## OCaml API reference

- [API glossary](https://libtmux.org/en/ocaml/latest/reference/glossary/): Kinds, modifiers and package labels in the OCaml API reference.

## OCaml Workspace Manager

- [OCaml-based tmux workspace manager](https://libtmux.org/en/ocaml/latest/workspace/): Validate, preview and apply JSON workspaces through the native OCaml library.
- [OCaml workspace API reference](https://libtmux.org/en/ocaml/latest/workspace/reference/): Public OCaml workspace validation, planning and execution APIs.

## OCaml Workspace Manager API reference

- [API glossary](https://libtmux.org/en/ocaml/latest/workspace/reference/glossary/): Kinds, modifiers and package labels in the OCaml API reference.

## Topics

- [OCaml topics](https://libtmux.org/en/ocaml/latest/topics/): Understand native client operations, streaming and compatibility.

## Workspace Manager

- [Workspace guide](https://libtmux.org/en/ocaml/latest/workspace/source-guide/): Workspace guide: libtmux documentation.

## Reference

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

## Optional

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