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

Edit this page on GitHub

libtmux-workspace 0.0.1-alpha.12-SNAPSHOT · Source

Native services load and capture sessions, discover and search documents, convert formats, import configurations and run editors. Common commands, layout, environment, before scripts and diagnostics are implemented. Python shell evaluation and plugin/custom-builder loading use a checked tmuxp bridge. Human load progress supports presets, custom templates and a bounded script-output panel. Append keeps its original target session across input files.

Load a workspace from the terminalLink to section

Follow the local installation walkthrough from a workspace-cli checkout of the Java repository. It builds the native command and loads a small workspace on a private socket. After building, inspect the command without starting tmux:

Terminal window
$ workspace-cli/build/install/tmux-workspace/bin/tmux-workspace --help

Use detached load for the walkthrough. JSON and NDJSON output are available; choose the mode explicitly when scripting. The command/configuration reference below also documents tmuxp behavior and compatibility targets, so it is not a claim that every referenced feature works in this local implementation.

Current coverageLink to section

Python plugins and custom builders execute through the checked tmuxp bridge. Extension append rejects documents containing before_script to preserve the borrowed session. Complete configuration/capture coverage and full terminal/platform acceptance remain unfinished. Progress uses the initial terminal dimensions; it does not track resizing, and Unicode clipping is conservative.

For the released Python workflow, use tmuxp and its Python workspace guide. It is a separate application and remains useful when a required native feature is incomplete.

Start hereLink to section

The libtmux-workspace library module remains available for applications that build sessions through code. Internals documents that API:

  • Guides show application setup and builder calls.
  • Topics explain supported configuration and behavior.
  • Examples exercise the library or source consumer.
  • API covers the builder and configuration interfaces.

tmuxp command and configuration referenceLink to section

Use the local CLI’s help and the limits above when applying these compatibility references to native execution.

Esc

Type to search.