OCaml

Choose a port 22

Scripting & web

PythonNo matching page

RubyNo matching page

LuaNo matching page

JuliaNo matching page

TypeScriptNo matching page

PerlNo matching page

Compiled & native

RustNo matching page

GoNo matching page

C++No matching page

Common LispNo matching page

SwiftNo matching page

OCaml

HaskellNo matching page

JVM

JavaNo matching page

KotlinNo matching page

ScalaNo matching page

ClojureNo matching page

.NET

C#No matching page

F#No matching page

PowerShellNo matching page

BEAM

ErlangNo matching page

ElixirNo matching page

tmux

tmux CLI

GitHub

Packages

Packages and source 6

libtmuxopam package · lib libtmux-unixopam package · unix libtmux-eioopam package · eio libtmux-jsonopam package · json libtmux-workspaceopam package · workspace libtmux-workspace-cliopam package · cli

OCaml · libtmux/libtmux-ocaml

Auto Light Dark

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.

.mobile-toolbar, .documentation-context-navigation, #mobile-sidebar, #mobile-toc { display: none !important; }

Workspace Manager: API Reference

Up Root

`Libtmux_json.Workspace`

module Workspace module libtmux-json [source] ¶

Public owner: Libtmux_json

Validate workspace documents and describe plans and retained execution. Preview output never supplies executable targets.

Members4#

Common operations1#

of_string function Decode libtmux.workspace/1 with the query codec's 64 KiB, UTF-8 and 32-level JSON bounds. Reject duplicate and unknown properties, invalid argv/shell combinations and configuration errors. directory is the absolute document directory; these functions perform no filesystem I/O.

Other members3#

decode function
encode_plan function Describe libtmux.workspace-plan/1 without I/O. The advisory preview contains command argv, cwd and environment names, excluding environment values, option values and startup text. It is not an execution script.
encode_receipt function 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.

Reference preview