# Libtmux_workspace

**Workspace Manager concept example** A working example of the core library. It can change without notice.

- **Package:** libtmux-workspace
- **Language:** OCaml
- **Kind:** module
- **Source:** https://github.com/libtmux/libtmux-ocaml/blob/205dfda49742592b479247049d186956e4a4cfe9/workspace/libtmux_workspace.mli#L1
- **Page:** https://libtmux.org/en/ocaml/latest/workspace/reference/libtmux_workspace/

```ocaml
module Libtmux_workspace
```

[`Config`](/en/ocaml/latest/workspace/reference/libtmux_workspace-config/) validates workspace descriptions and [`Plan`](/en/ocaml/latest/workspace/reference/libtmux_workspace-plan/) previews their actions without I/O. [`Execution`](/en/ocaml/latest/workspace/reference/libtmux_workspace-execution/) delegates effects to an explicit executor and retains a recovery journal. See the [workspace guide](https://github.com/libtmux/libtmux-ocaml/blob/master/docs/workspaces.md) for JSON loading, preview, apply and receipt inspection.

## Members

### Other members

- [`Config`](/en/ocaml/latest/workspace/reference/libtmux_workspace-config/) (module): Validate native workspace values without contacting tmux or reading the filesystem. Relative directories resolve against the document directory; only declared variables participate in expansion.
- [`Execution`](/en/ocaml/latest/workspace/reference/libtmux_workspace-execution/) (module): Apply a plan once per handle and retain effects, uncertainty and cleanup. The journal lives in process memory while its execution handle is retained; {!Execution.val-inspect} returns immutable copies. It survives waiter cancellation and client closure, but supplies no crash-durable recovery or cross-invocation deduplication. Ordinary applications use their backend's Workspace module; executors below integrate another transport.
- [`Plan`](/en/ocaml/latest/workspace/reference/libtmux_workspace-plan/) (module): Preview ordered workspace actions against one observed daemon generation. A plan retains collision policy and bound targets; it is not a portable command script.

## Guides

Pages that discuss `Libtmux_workspace`.

- [OCaml workspace API reference](/en/ocaml/latest/workspace/reference/)