Native services discover, search, convert, import, edit, load, append and capture workspaces. Common directories, command inheritance, indexes, focus, session environment/options and before scripts are supported. Python shell evaluation uses a checked tmuxp bridge.

load -2 forces 256-color handling in native tmux clients. Legacy -8 is recognized but rejected before document lookup because supported tmux versions do not implement 88-color mode. Without -2, tmux detects color support.

Load a workspace from the terminalLink to section

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

$ .build/debug/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

--log-level filters advisory diagnostics; fatal errors remain visible. load --log-file appends structured lifecycle and diagnostic records to a regular file. A write failure reports a secondary diagnostic and preserves the load result.

Human load displays progress on terminal stderr, with presets, custom counters and a bounded recent-output panel. It uses the initial terminal size and conservative Unicode clipping. Bootstrap output streams to its original stdout or stderr destination and updates the panel while the script runs. Machine output disables the panel and sends child text as structured stderr warnings; load events remain on stdout. See the child output contract for limits and cancellation behavior.

Human load with a foreground terminal attaches to the final workspace. Inside tmux, choose switch, detached load, append or cancel. -y skips the mode prompt and refuses an ambiguous client selection. Redirected and machine calls require -d or --append. Detaching or interrupting the client preserves loaded sessions.

Plugins/custom builders, further pane/window execution settings, fuller capture, generated manuals and portable distribution remain unfinished. Parser coverage does not establish support for every configuration field or execution path.

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 TmuxWorkspace SwiftPM library product 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.