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.workspace.cli:main

(main &key (arguments (command-line-arguments)) (stdout *standard-output*) (stderr *error-output*))

Public owner: libtmux.workspace.cli

Run the workspace CLI for ARGUMENTS and return process status 0, 1, or 2. VALIDATE and PLAN parse one bounded file without tmux I/O. APPLY requires --socket-path and optionally accepts --program; it scopes and closes its own client without terminating the server. STDOUT receives one JSON result or help. STDERR receives usage text or one JSON error retaining condition causes, failed step data, and command outcomes, including byte arrays and unknown dispatch status. An unavailable exit code or failed step is omitted. MAIN does not call UIOP:QUIT, close caller streams, or enter the debugger. Nested diagnostic details stop after eight levels and mark detailsTruncated.

Parameters

Guides#

Pages that discuss main.

Esc

Type to search.

Reference previewOpen reference