1191 symbols, extracted from source. Every type name in a signature links to its own entry; every cross-reference in a doc comment resolves against the same table.
Server 4 types
Identifies one tmux daemon generation.
Reads one isolated, single-session psmux namespace.
Represents an immutable server handle and snapshot.
Owns a server and stops it when disposed.
Session 5 types
An immutable observation of the sole psmux session.
Represents an immutable session handle and snapshot.
Owns a session and stops it when disposed.
Owns a window and stops it when disposed.
Represents a generation-independent tmux session identifier.
Window 5 types
Defines relative window placement.
An immutable observation of one psmux window.
Represents an immutable window handle and snapshot.
Names which way a window's panes rotate.
Represents a generation-independent tmux window identifier.
Pane 5 types
Defines pane placement directions.
Represents an immutable pane handle and snapshot.
Represents a generation-independent tmux pane identifier.
An immutable observation of one psmux pane.
Controls whether workspace panes wait for a prompt-like state.
Client 2 types
Identifies a client and resolves what it is looking at.
What one client is looking at.
Hooks 3 types
One command a hook runs, and where it sits in the order.
One hook and every command it runs.
The hooks of one server, session, window, or pane.
Options 4 types
Defines tmux option scopes.
What tmux reported for an option.
One option value as tmux reported it.
One option, with its array index when tmux gave it one.
Keys and bindings 1 type
The key bindings of one server.
Buffers 2 types
The paste buffers of one server.
One tmux paste buffer.
Layout and geometry 1 type
Defines pane resize directions.
Environment 2 types
One variable in a tmux environment.
The environment tmux gives to the processes it spawns.
Versions 1 type
Represents one lossless parsed tmux version.
Commands 4 types
One tmux command and the arguments it carries.
Says whether a failed command reached tmux, which is what decides if retrying is safe.
One tmux invocation, as a TmuxInterceptor sees it.
Waits for tmux to reach a state instead of sleeping.
Control mode 3 types
Subscribes a control client to a format changing.
A live tmux control client.
Narrows a control client's event stream to one pane, and ends it cleanly.
Queries 7 types
A tmux filter expression passed through without translation.
Parses the one legacy lookup spelling this port still carries.
One translated query predicate and its wire schema.
Translates, compiles, and applies declarative query predicates.
Names the tmux object a field or quantifier reads.
Bounds one JSON document so parsing cannot be weaponised.
Serializes query documents to the stable v1 wire form.
Snapshots 5 types
Holds the children a snapshot captured for one relation.
Holds the one child a snapshot captured for a relation, if it read it.
Places one window at one index inside one session.
Names how far down the tmux hierarchy a snapshot captured.
Identifies one window linked into one session.
Requests 31 types
A request that becomes one tmux command against a target.
Describes one bind-key invocation.
Names how a chooser orders its rows.
Describes one choose-tree invocation.
What a command prompt is asking for.
Describes one command-prompt invocation.
Describes one confirm-before invocation.
Describes one copy-mode invocation.
Describes one display-menu invocation.
Describes one display-message invocation.
Names when a popup closes on its own.
Describes one display-popup invocation.
Describes one show-options invocation for a single option.
Describes one show-options invocation for every option in a scope.
Describes one hook to read, run, or unset.
Describes one if-shell invocation.
Describes one list-buffers invocation.
Describes one show-hooks invocation.
Describes one paste-buffer invocation.
Describes one respawn-window or respawn-pane invocation.
Describes one run-shell invocation.
Names a layout change that needs no layout string.
Describes one select-layout invocation.
Describes one send-keys invocation.
Describes one set-hook invocation.
Describes setting several entries of one hook at once.
Describes one set-option invocation.
Describes one unbind-key invocation.
Describes one set-option -u invocation.
What to do with a wait-for channel.
Describes one wait-for invocation.
Requests — Server 1 type
Describes one server-access invocation.
Requests — Session 2 types
Describes one attach-session invocation.
Describes one new-session invocation.
Requests — Window 6 types
Describes one find-window invocation.
Describes one link-window invocation.
Describes one move-window invocation.
Describes one new-window invocation.
Names how a window is resized against its clients.
Describes one resize-window invocation.
Requests — Pane 11 types
Names one end of a capture range.
Describes one capture-pane invocation.
Describes one move-pane or join-pane invocation.
Describes one new-pane invocation.
Describes one pipe-pane invocation.
Describes one resize-pane invocation.
Names which pane a selection moves to.
Describes one select-pane invocation.
Describes one split-window invocation.
Names which neighbouring pane a swap uses.
Describes one swap-pane invocation.
Errors 16 types
Reports a command rejected by a live tmux control client.
Thrown when a snapshot never captured the requested relation.
Provides the base exception for remote tmux failures.
Reports a failure to clean up a canceled tmux client.
Reports a command-policy failure.
Reports a missing tmux executable.
Reports a missing tmux object.
Reports cancellation after a tmux client started.
Thrown when tmux refuses an option name or value.
Reports an answer from tmux this library could not read.
Reports a process-transport failure.
Reports an unsupported tmux version.
Reports an expired bounded wait.
Thrown when an expression cannot be translated to a query.
Reports a workspace failure and the tmux state created before it.
Thrown when a workspace file cannot be read.
Errors — Server 1 type
Reports a stale server generation.
Errors — Session 1 type
Thrown when a session name is already taken.
Errors — Window 1 type
Thrown when a window operation is refused before tmux sees it.
Errors — Pane 1 type
Thrown when a pane operation is refused before tmux sees it.
Constants and enums 12 types
One thing a tmux control client reported without being asked.
Bytes a pane wrote.
A notification this library does not parse further.
Reports notifications discarded because the bounded event buffer was full.
The control client ended.
The options of one server, session, window, or pane.
Chooses the psmux pane text that can be captured safely.
Configures the bounded psmux query preview.
What show-messages should list.
Defines the tmux client color mode.
Contains the inspectable result of one raw tmux command.
Describes workspace state materialized by a build.
Constants and enums — Server 1 type
Configures a tmux server connection without mutating process-wide state.
Constants and enums — Pane 2 types
The pane a stream was watching left its window's arrangement.
Names whether a pane accepts input.
Testing utilities 9 types
A server, session, window, and pane a test owns together.
Creates a throwaway server for a test and stops it afterwards.
Owns a throwaway session and any private server created with it.
Owns a throwaway window and any private session and server created with it.
The directory and variables a test's tmux runs with.
Makes names no other test is using.
A tmux server a test owns, and the environment it runs in.
Makes the tmux objects a test needs, each owning its own cleanup.
How a test's tmux is reached and how long it is waited on.
Other 6 types
Commands tmux runs together, in one process.
Runs a request on its own, as a chain of one command.
Reports package identity and supported tmux range.
Names the diagnostic sources this library publishes.
One line of a tmux menu.
An open wait on a tmux wait-for channel.
By module 7 modules
-
LibTmux 136
- Captured
Relation - Captured
Value - Client
- Control
Mode Command Exception - Control
Mode Subscriptions - Incomplete
Snapshot Exception - Lib
Tmux Exception - Lib
Tmux Info - Owned
Server Scope - Owned
Session Scope - Owned
Window Scope - Pane
- Pane
Observation - Psmux
Capture Options - Psmux
Connection Options - Psmux
Pane - Psmux
Server - Psmux
Session - Psmux
Window - Server
- Session
- Stale
Server Generation Exception - Tmux
Buffers - Tmux
Chain - Tmux
Chaining - Tmux
Cleanup Exception - Tmux
Command Exception - Tmux
Command Not Found Exception - Tmux
Environment - Tmux
Hooks - Tmux
Invocation - Tmux
Keys - Tmux
Object Not Found Exception - Tmux
Operation Canceled Exception - Tmux
Option Exception - Tmux
Options - Tmux
Pane Exception - Tmux
Protocol Exception - Tmux
Session Exists Exception - Tmux
Transport Exception - Tmux
Version Too Low Exception - Tmux
Wait - Tmux
Wait Channel - Tmux
Wait Timeout Exception - Tmux
Window Exception - Unsupported
Query Expression Exception - Window
- Choose
Tree Sort - Option
Scope - Pane
Direction - Pane
Input Mode - Pane
Select Direction - Pane
Swap Direction - Popup
Close Mode - Prompt
Type - Resize
Direction - Select
Layout Mode - Show
Messages Mode - Snapshot
Depth - Tmux
Color Mode - Tmux
Dispatch State - Tmux
Option State - Tmux
Wait Mode - Window
Direction - Window
Resize Mode - Window
Rotation Direction - IControl
Mode Session - ITmux
Request - Attach
Session Request - Bind
Key Request - Capture
Pane Position - Capture
Pane Request - Choose
Tree Request - Command
Prompt Request - Confirm
Before Request - Copy
Mode Request - Display
Menu Request - Display
Message Request - Display
Popup Request - Find
Window Request - Get
Option Request - Get
Options Request - Hook
Request - If
Shell Request - Link
Window Request - List
Buffers Request - List
Hooks Request - Move
Pane Request - Move
Window Request - New
Pane Request - New
Session Request - New
Window Request - Pane
Id - Paste
Buffer Request - Pipe
Pane Request - Resize
Pane Request - Resize
Window Request - Respawn
Request - Run
Shell Request - Select
Layout Request - Select
Pane Request - Send
Keys Request - Server
Access Request - Server
Connection Options - Server
Generation - Session
Id - Session
Window Edge - Set
Hook Request - Set
Hooks Request - Set
Option Request - Split
Pane Request - Swap
Pane Request - Tmux
Buffer - Tmux
Command - Tmux
Command Result - Tmux
Environment Entry - Tmux
Hook - Tmux
Hook Entry - Tmux
Menu Item - Tmux
Option - Tmux
Option Value - Tmux
Version - Unbind
Key Request - Unset
Option Request - Wait
For Request - Window
Entity Key - Window
Id - Tmux
Diagnostics - Client
Attachment - Tmux
Event - Tmux
Events Dropped Event - Tmux
Exit Event - Tmux
Notification Event - Tmux
Output Event - Tmux
Pane Gone Event - Unsafe
Tmux Filter
- Captured
-
LibTmux.Mcp 27
- Lib
Tmux Mcp - Mcp
Server Composition - Pane
Activity Hub - Server
Instructions - Tmux
Connection Accessor - Wait
Outcome - Bounded
Text - Pane
Info - Server
Policy - Session
Info - Window
Info - Action
Result - Capture
Result - Channel
Wait Result - Environment
Entry - Hook
Entry - Key
Step - Matched
Line - Option
Entry - Pane
Input Result - Pane
Match - Pane
Snapshot - Run
Result - Search
Result - Tail
Result - Tmux
Server Info - Wait
Result
- Lib
-
LibTmux.Query 4
-
LibTmux.Query.Json 2
-
Types 25
- Action
Result - Capture
Result - Channel
Wait Result - Client
Attachment - Environment
Entry - Hook
Entry - Key
Step - Matched
Line - Option
Entry - Pane
Input Result - Pane
Match - Pane
Snapshot - Run
Result - Search
Result - Tail
Result - Tmux
Diagnostics - Tmux
Event - Tmux
Events Dropped Event - Tmux
Exit Event - Tmux
Notification Event - Tmux
Output Event - Tmux
Pane Gone Event - Tmux
Server Info - Unsafe
Tmux Filter - Wait
Result
- Action