Workspace ManagerconceptAPI Reference

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.

Workspace Manager: API Reference

Libtmux_json.Workspace.encode_receipt

val encode_receipt : Libtmux_workspace.Execution.receipt -> (Yojson.Safe.t, Decode_error.t) result

Public owner: Libtmux_json

Describe libtmux.workspace-receipt/1 with ordered steps, outcome index lists, creation IDs, unbound hints and per-pane cleanup. Diagnostic messages are limited to 4096 bytes with an explicit truncation flag; command payloads are omitted.

Description#

Both output schemas have a 4 MiB bound. Invalid UTF-8 values use {"encoding":"hex","bytes":"..."} instead of losing bytes. Imported IDs and hints never establish a connection binding.

Esc

Type to search.

Reference previewOpen reference