libtmux
C#

Choose a port 13

Scripting & web

Python Ruby Lua TypeScript

Compiled & native

Rust Go C++ Swift

JVM

Java KotlinUnavailable ScalaUnavailable

.NET

C# F#Unavailable

tmux

tmux CLI

Search
Colour scheme
Menu
Reference MCP
Workspace ManagerHome

Choose documentation 3

C# · latest · en
latest

Current version

latest
English

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

Edit this page on GitHub

C# workspace manager

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.

CLI Manual

Commands, options and machine output.

Configuration

Workspace fields, normalization and execution.

Install and load

Load a workspace on a private socket, then capture it.

Example gallery

Workspace files to start from, with their prerequisites.

Runtime support

Runtime requirements and supported behavior.

Internals

The workspace library, for building sessions from code.

tmux-workspace creates tmux sessions from YAML or JSON. A file describes windows, panes, commands, directories and environment. Load it from a terminal or request machine output for automation.

Load a workspace from the terminal

  1. Install the command and load a workspace.
  2. Configure windows and panes.
  3. Capture and reload a session.

The CLI manual covers discovery, search, editing, loading, capture, conversion and import. Examples provide complete configurations with their prerequisites.

Automate and inspect

Use load -d when the caller should return without attaching. --json returns a result, and --ndjson supports a stream of records. Read automation for retry and cleanup decisions and errors for failure handling.

Loaded workspaces are ordinary tmux sessions. Select the same socket when inspecting them from tmux or the MCP server.

Build from application code

The workspace library has its own API and configuration contract. Use it when a program needs direct control over construction. The CLI task guides here describe the tmux-workspace executable and link to its documented source revision.

CLI source.

Esc

Type to search.