Core LibraryunreleasedGuides

Choose documentation 2

latest

Current version

latest
English

Unreleased libtmux has not been released. Its API may change during development. This site's structure and URLs may change too.

Current capabilities and adoption gaps

The immutable model, typed queries, native Linux clients and output observation have real-tmux evidence at the active tmux endpoints, 3.3a and 3.8. Intermediate releases remain supported throughout 3.3a–3.8. The installed workspace CLI also passes those cells. The final suite review remains unfinished. No package or hosted-documentation release has been published.

What an application can use

Capture a complete graph, retain it after closing the client, traverse shared windows through session-specific links, filter with native predicates or typed expressions, and establish cardinality before an explicit mutation. Native operations cover sessions, windows, panes, captured clients, layouts, environment, options and hooks. Both blocking and Eio transports retain operation outcomes and expose bounded subscriptions.

The compatibility table identifies qualified components. The examples are installed, compiled and executed against owned servers; they cover graph links, query results, created resources, literal input, streaming, rendered waits and client teardown.

What is still missing

AreaRequired evidence before complete-suite adoption
Documentation siteQualify the final hosted reference and verify its deployed links; public .cmti export and local rendering are implemented
Known runtime findingsAccount for the recorded daemon-exit and observer failures when choosing a deployment workload
Final qualificationRerun every required component and exact release cell on the final source revision
Package adoptionObtain an independent caller-task review and resolve material findings

Recorded benchmarks cover blocking/Eio capture, graphs up to 256 panes, concurrent requests, OCaml heap allocation, client/daemon CPU, future-output latency and cancellation cleanup. Their raw data preserves the workload, source identities and host conditions.

The workspace model, JSON loader, blocking/Eio executors and installed CLI are implemented. The workspace guide executes the installed command through validation, planning, apply, receipt inspection and owned cleanup. Live tests cover partial effects, compensation, append isolation, stale plans, cancellation journals and bootstrap on fresh and existing daemons. Cleanup targets only proven newly created panes; foreign panes moved into a new window remain. Versioned advisory plans and execution receipts preserve errors, creation IDs and cleanup outcomes; output documents cannot be replayed as operational input. CLI checks also cover malformed input, collisions, missing endpoints, interrupted apply, changed documents and stalled or broken stdout.

Engineering assessment

For a Linux application needing immutable tmux observations and explicit native control, the model and clients are candidates for adoption with the documented constraints. Suite adoption still needs the documentation and qualification above. Maintainer count and alpha status do not decide that assessment; observable behavior and recovery do.

An adopting engineer should expect explicit endpoint selection, client lifetime, command uncertainty and stream gaps. The package should keep these visible. Implicit reconnects, callback-driven property acquisition, a mandatory query wrapper or a required runtime for pure filtering would make the API harder to reason about.

A 9.5/10 whole-package rating is not established. Hosted documentation and final qualification have open gates. Documentation quality cannot substitute for those results. Testing describes current evidence and how examples are kept in sync with source.

MCP integration is excluded by project policy. Its SDK, conformance and host integration are outside the adoption criteria. The supported automation surfaces are native OCaml APIs and the workspace CLI; see package boundaries.

Esc

Type to search.

Reference previewOpen reference