API Reference¶
This is the internal Python API — the modules tmuxp’s CLI is built from, documented for contributors and plugin authors. Everyday use goes through the CLI; to drive tmux from Python directly, reach for libtmux instead.
See also
See libtmux’s API and Quickstart to see how you can control tmux via python API calls.
Workspace
Finding, loading, building, and freezing sessions.
CLI modules
The argparse commands behind each subcommand.
Plugin API
The TmuxpPlugin base class and its hooks.
Internal helpers
Config reader, colors, and private path helpers.
Exceptions
The TmuxpException hierarchy.
Logging
Loggers and user-facing echo helpers.
Shell
Internals of the interactive shell launcher.
Utilities
Assorted helpers used across tmuxp.
Types
Shared type definitions.