# OCaml workspace API reference

Source: https://libtmux.org/en/ocaml/latest/workspace/reference/

> Public OCaml workspace validation, planning and execution APIs.

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

Use [`Libtmux_workspace`](<https://libtmux.org/en/ocaml/latest/workspace/reference/libtmux_workspace/>) to validate configuration and build a plan without I/O.
Execute the plan through an explicit native client and retain its journal for
recovery. [`Libtmux_json`](<https://libtmux.org/en/ocaml/latest/reference/libtmux_json/>) decodes the versioned workspace JSON format.

The declarations below document the workspace library at this site's source
revision. The [workspace guide](https://libtmux.org/en/ocaml/latest/workspace/source-guide/) shows installation, planning,
execution and receipt inspection with `tmux-workspace`.

## API declarations

- [Libtmux_workspace](https://libtmux.org/en/ocaml/latest/workspace/reference/libtmux_workspace/)
- [Libtmux_eio.Workspace](https://libtmux.org/en/ocaml/latest/workspace/reference/libtmux_eio-workspace/)
- [Libtmux_json.Workspace](https://libtmux.org/en/ocaml/latest/workspace/reference/libtmux_json-workspace/)
- [Libtmux_unix.Workspace](https://libtmux.org/en/ocaml/latest/workspace/reference/libtmux_unix-workspace/)
