.NET API reference

Reads one isolated, single-session psmux namespace.

Represents an immutable server handle and snapshot.

Owns a server and stops it when disposed.

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.

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.

Defines pane placement directions.

Represents an immutable pane handle and snapshot.

An immutable observation of one psmux pane.

Controls whether workspace panes wait for a prompt-like state.

Identifies a client and resolves what it is looking at.

What one client is looking at.

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.

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.

One tmux paste buffer.

Defines pane resize directions.

One variable in a tmux environment.

The environment tmux gives to the processes it spawns.

One tmux command and the arguments it carries.

Says whether a failed command reached tmux, which is what decides if retrying is safe.

Renders typed argv as one physical tmux control-input line.

Reads one tmux control client and correlates what it says.

A live tmux control client.

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.

Evaluates a query document against in-memory elements.

Names the tmux object a field or quantifier reads.

Names an ordering or equality comparison.

Names a string comparison, always ordinal.

Translates a supported expression into a query document.

Writes the stable v1 wire form of a query document.

Reads the stable v1 wire form back into a query document.

Bounds one JSON document so parsing cannot be weaponised.

Serializes query documents to the stable v1 wire form.

A tmux format field operand.

Names how a quantifier folds a relation.

A quantifier over a relation field.

One node of a translated query predicate.

One literal value in a query predicate.

The absence of a value.

A boolean literal.

A 64-bit integer literal.

A string literal.

A typed tmux identifier literal.

A literal operand.

An ordering or equality comparison.

An ordinal string comparison.

A constant-pattern regular expression match.

The negation of one predicate.

The conjunction of ordered operands.

The disjunction of ordered operands.

Holds the children a snapshot captured for one relation.

Places one window at one index inside one session.

Names how far down the tmux hierarchy a snapshot captured.

Builds a tmux session from a tmuxp workspace file.

Describes one pane in a supported tmuxp workspace.

Describes one window in a supported tmuxp workspace.

Describes the supported subset of one tmuxp workspace.

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.

Describes one server-access invocation.

Describes one attach-session invocation.

Describes one new-session invocation.

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.

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.

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 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.

Reports a stale server generation.

Thrown when a session name is already taken.

Thrown when a window operation is refused before tmux sees it.

Thrown when a pane operation is refused before tmux sees it.

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.

Configures a tmux server connection without mutating process-wide state.

Names whether a pane accepts input.

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.

Waits for tmux to reach a state instead of sleeping.

Buffers notifications without allowing a slow consumer to stall commands.

Validates tmux session names.

Prepares a tmux -c start-directory value.

Resolves stable entity identifiers without materializing collections.

Executes tmux commands only while a materialized server generation is live.

Carries one materialized row's copied fields and its place in the tmux hierarchy.

Names how a server enumerates its immediate children.

Describes how a tmux server projects its own children.

Selects the tmux format fields one list command can resolve on one tmux version, and renders them as a self-describing -F template.

Names the server that owns every entity one materialization produces.

Reads one live relation and rebuilds owned entity handles.

Decodes tmux rows whose scalars are separated by an unguessable marker.

Runs one tmux read and materializes its framed rows.

Turns framed tmux rows into decoded fields and owned entity handles.

What the Python names became here.

The multiplexer a connection speaks to, and how it is addressed.

Speaks to the psmux preview, which serves one isolated session.

Speaks to a real tmux server.

Owns the exact psmux build and endpoint spellings this preview accepts.

Records what tmux was asked and what it answered.

Turns a failed option command into a typed failure.

Carries the logger a run of tmux commands is recorded through.

Isolates a tmux child process from an inherited tmux session.

Resolves one immutable connection endpoint and its child environment.

Reads what show-options printed.

Reads the variables tmux exports into the panes it spawns.

Where the TMUX variable says a server is.

Builds the argv for the server's utility commands.

Commands tmux runs together, in one process.

Turns a request record into a command a chain can carry.

Reports package identity and supported tmux range.

One line of a tmux menu.

An open wait on a tmux wait-for channel.