Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Automate workspace operations

Edit this page on GitHub

TmuxWorkspace 0.1.0-alpha.5 · Source

tmuxp compatibility reference. Examples using tmuxp run the Python reference. Local CLI status describes this port’s implemented coverage.

For the current Python loader, supply an explicit file, dedicated socket, and -d to avoid attachment. --yes answers yes/no questions; it is not a universal replacement for missing session, format, or destination choices.

Read current recordsLink to section

Terminal window
$ tmuxp ls --json

Validate the JSON object before consuming its workspaces array. Python search has different empty-result behavior: no matches can produce no bytes rather than []. See search before relying on a pipeline.

Proposed native machine protocolLink to section

Local native CLIs provide --json and --ndjson. Implemented services and terminal behavior vary by port. The shared machine contract resolves choices from arguments, avoid implicit stdin prompts, keep diagnostics on stderr, and prevent child output or attachment from corrupting stdout. The operation result must report partial completion instead of claiming rollback.

NDJSON load events must be observable while work is still running, followed by exactly one terminal record. A buffered array split into lines after completion does not meet this requirement. Both output flags together select NDJSON.

Read output for stream shapes and exit behavior for errors and interruption. Export and reload distinguishes document encoding from CLI result encoding.

tmuxp reference source.

Esc

Type to search.