API Reference¶
libtmux’s public API mirrors tmux’s object hierarchy:
Server -> Session -> Window -> Pane
Core Objects¶
Server
Entry point. Manages sessions and executes raw tmux commands.
Session
Manages windows within a tmux session.
Window
Manages panes, layouts, and window operations.
Pane
Terminal instance. Send keys and capture output.
Supporting Modules¶
Common
Base classes and command execution.
Neo
Dataclass-based query interface.
Options
tmux option get/set.
Hooks
tmux hook management.
Constants
Format strings and constants.
Exceptions
Exception hierarchy.
Test Utilities¶
If you’re testing code that uses libtmux, see the test helpers and pytest plugin: