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

Edit this page on GitHub

tmux-workspace 0.1.0-alpha.12 · Source

Native services load and capture sessions, discover and search documents, convert formats, import tmuxinator/teamocil files, and run editors. Python shells and workspace extensions use an explicit version-checked bridge. Append validates the current daemon and retains the borrowed session across inputs.

Load a workspace from the terminalLink to section

Follow the local installation walkthrough from a workspace-cli checkout of the Rust 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
$ target/release/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

Native load supports filtered file logging.

Human load supports progress templates and bounded script lines. Attachment checks the terminal and invoking client before mutation. SIGINT and SIGTERM report completed inputs and acknowledged effects; interruption does not roll them back. Human bootstrap scripts retain terminal stdin with foreground and terminal-setting restoration on supported targets.

Human listing supports tree and full views with escaped labels. Native generation exports command metadata, manuals and completion scripts without starting tmux or Python. Discovery/search edge cases, complete configuration coverage and broader platform lifecycle validation remain open. See the compatibility reference for cancellation and platform limits.

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 tmux-workspace library crate 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.