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.0-alpha.14 · Source

Install

Install the workspace package separately from the core library.

$ dotnet tool install --global LibTmux.Workspace.Cli --prerelease

--prerelease is required: every release so far carries an -alpha tag. Add $HOME/.dotnet/tools to PATH if the shell cannot find tmux-workspace.

$ dnx LibTmux.Workspace.Cli --prerelease --yes -- --help

Runs it once from NuGet without installing anything; needs the .NET 10 SDK.

$ dotnet tool install LibTmux.Workspace.Cli --prerelease

Run at a repository root: it writes dotnet-tools.json, which pins the version for everyone who clones it. Run it as dotnet tmux-workspace.

Native services load/reuse/append and capture sessions, discover and search documents, convert formats, import configurations and run editors. A checked Python bridge provides Python-specific shell and workspace-extension behavior.

Load a workspace from the terminalLink to section

Install tmux-workspace from NuGet with any method under Install. The installation walkthrough loads a small workspace on a private socket. Inspect the command without starting tmux:

Terminal window
$ 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 implementation.

Current coverageLink to section

Native imports preserve supported command groups, directories, Teamocil options/focus and synchronization timing. They validate the translated workspace before printing or saving it and refuse unsupported lifecycle fields. Load creates panes in configuration order; pane configuration explains indexes and focus.

Native --log-level filters optional diagnostics. On Linux x64, load --log-file appends structured logs; see the output reference for destination and failure handling.

On Linux x64, human load shows terminal progress on stderr, with presets, literal token templates and bounded script output. See load for counters, stream handling and resize limits.

Native append retains the current pane’s resolved session across all inputs, even if a script moves the pane. Later commands reject a replacement daemon. Append with Python plugins or custom builders is unavailable and fails before building any input or starting Python; use -d for those extensions.

Human load supports attachment and client-selection prompts from a foreground controlling terminal on Linux x64. It authenticates the invoking pane and selected daemon before building, then checks the client again before handoff. See native attachment for choices and interruption behavior.

Attached Python extension handoff, broader extension lifecycle validation, contextual completion, and the full configuration and platform corpus remain unfinished.

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 package 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 CLI’s help and the limits above when applying these compatibility references to native execution.

Esc

Type to search.