TypeScript

Choose a port 16

Scripting & web

PythonNo matching page

RubyNo matching page

LuaNo matching page

JuliaNo matching page

Compiled & native

RustNo matching page

GoNo matching page

C++No matching page

SwiftNo matching page

JVM

JavaNo matching page

KotlinNo matching page

ScalaNo matching page

.NET

C#No matching page

F#No matching page

PowerShellNo matching page

BEAM

ElixirNo matching page

tmux

Packages

Packages and source 9

Source

libtmuxpackages/libtmux libtmux-tslibtmux/libtmux-ts @libtmux/mcppackages/mcp @libtmux/workspacepackages/workspace @libtmux/workspace-clipackages/workspace-cli

Packages

libtmuxnpm @libtmux/mcpnpm @libtmux/workspacenpm @libtmux/workspace-clinpm

TypeScript · libtmux/libtmux-ts

Auto Light Dark

Workspace ManagerconceptAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

0.x Released; the API may change. Read more

MCP Tools for connected assistants

Home Guides Topics Examples Tools Prompts Resources API Reference

concept Working example; may change without notice. Read more

Workspace Manager Repeatable development environments

Home Guides Examples CLI Manual API Reference Configuration Internals

concept Working example; may change without notice. Read more

latest

Current version

English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

.mobile-toolbar, .documentation-context-navigation, #mobile-sidebar, #mobile-toc { display: none !important; }

Workspace Manager: API Reference

`planning.WorkspaceRetention`

type planning.WorkspaceRetention = | { readonly count: number; readonly kind: "panes"; readonly reason: "pruning-disabled" | "shared-window"; readonly window: WorkspaceWindowPlacement; } | { readonly kind: "window"; readonly reason: "grouped-session" | "pruning-disabled"; readonly window: WorkspaceWindowPlacement; } typealias [source] ¶: Surplus topology retained because removing it would exceed the policy.

Reference preview