Native services load and attach sessions, reuse exact names, append windows, capture topology, discover and search documents, convert formats, import configurations and run editors. Ordinary search uses C++ regular expressions.

Load a workspace from the terminalLink to section

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

$ build/cxx-dev/apps/workspace/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

before_script runs a quoted command directly after session creation or append selection, before settings and windows. All inputs are validated first. Script failure removes a newly owned session and preserves a borrowed append session; NDJSON streams script output while the child runs.

Human load requires a foreground terminal. It attaches outside tmux or switches the unique terminal client viewing the invoking pane. The final input selects the session, including reuse. Output is flushed before handoff; failures retain loaded changes. See loading and attachment.

Independent active-pane focus on the invoking physical window requires -d or --append, including linked windows.

load --log-file PATH appends JSON diagnostics. Log levels filter optional records without hiding required errors or changing machine results. See logging for file and failure behavior.

Human load has terminal progress with presets, templates and bounded script output. Native Bash, Zsh and Fish completion covers commands, flags, choices and paths. Dynamic session/configuration-name suggestions remain unavailable.

Human ls --tree groups workspaces by directory; --full includes parsed configuration. The optional shell uses an installed tmuxp 1.74.0 executable, with streaming and terminal restoration. Native loading remains independent of Python.

Plugin/custom-builder execution, full importer/configuration coverage and portable packaging remain unfinished. Capture preserves local session/window options but omits inherited/global options and environment. It cannot recover original command arguments or history.

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 workspace_builder source consumer 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.

Installation walkthrough builds and runs the local native CLI.
Inspect through MCP connects to the loaded session.
Command reference lists tmuxp commands, flags and compatibility targets.
Configuration covers fields, normalization and execution.
Example gallery includes upstream fixtures and prerequisites.
Compatibility status records builder/reference gaps.
JSON, NDJSON, and color describes the shared output design.