Core LibraryAPI Reference

Choose documentation 2

latest

Current version

latest
English

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

API reference

Browse the LibTmux cmdlets by the tmux objects and operations they control. Each command includes syntax, parameter sets, pipeline types, and examples.

Server 3 cmdlets

Construct a tmux endpoint handle without contacting it.

Inspect an existing tmux daemon's identity and version.

Discover the server at an explicit endpoint.

Session 5 cmdlets

Read sessions with optional exact selectors.

Filter captured native sessions.

Create a detached session on an explicit server.

Attach your foreground terminal to a selected session.

Remove an explicit native session without emitting an object.

Window 8 cmdlets

Read contextual windows from a server or session.

Filter captured native windows.

Create a window in an explicit session.

Resize a window in cells or against its attached clients.

Move one session placement of a window.

Remove a physical window and all its session links.

Pane 10 cmdlets

Read panes from a server, session or window.

Filter captured native panes.

Capture rendered text from a pane.

Split an explicit pane and return the newly created pane.

Send literal text and optional Enter to a native pane.

Run a shell command in a native pane and report its exit status.

Wait for rendered text in a native tmux pane.

Refresh a pane into a replacement captured object.

Resize a pane or toggle its zoom.

Remove an explicit native pane without emitting an object.

Client 3 cmdlets

Read the clients attached to a tmux server.

Resolve the session, window and pane a client currently views.

Refresh a client into a replacement captured object.

Hooks 4 cmdlets

Read native grouped hooks from an owner table.

Set a hook entry and optionally return its grouped readback.

Run a configured tmux hook now.

Remove a hook or one indexed entry.

Options — Functions 3 cmdlets

Read a native tmux option table or named option.

Set an option in a native tmux owner table.

Unset an option so its inherited value applies.

Keys and bindings 1 cmdlets

Send an ordered sequence of tmux key tokens to a native pane.

Layout and geometry 1 cmdlets

Arrange the panes of a window.

Environment 3 cmdlets

Read native tmux environment entries.

Set a tmux environment variable for future processes or formats.

Unset an environment entry or keep an explicit removal marker.

Commands 3 cmdlets

Construct a native tmux command without running it.

Execute literal tmux arguments against an explicit server.

Execute an ordered command chain against one server.

Control mode 5 cmdlets

Attach a native control client to an explicit tmux target.

Stream native tmux events with bounded delivery and explicit ownership.

Wait for a tmux channel signal with a timeout and owned withdrawal.

Run a native command on a borrowed control client.

Dispose an explicitly supplied tmux control client.

Queries 4 cmdlets

Build reusable criteria for captured tmux objects.

Inspect how a query will run against a known tmux version.

Acquire fresh tmux objects using an explicit query.

Serialize a native query document.

Queries — Fields 1 cmdlets

Discover query fields, operators and native bindings.

Snapshots 1 cmdlets

Capture a replacement tmux hierarchy.

Other 1 type
LibTmux module 55 members

Native PowerShell automation over the LibTmux .NET core. Alpha.

Esc

Type to search.

Reference preview Open reference