tmuxp.plugin.TmuxpPlugin

Members

__init__ (self, kwargs: Unpack[PluginConfigSchema]) → None

mmethod [source] ¶

Initialize plugin.

Description#

The default version values are set to the versions that the plugin system requires.

Parameters

• kwargs (Unpack[PluginConfigSchema]) #

before_workspace_builder (self, session: Session) → None

mmethod [source] ¶

Provide a session hook previous to creating the workspace.

Description#

This runs after the session has been created but before any of the windows/panes/commands are entered.

Parameters

• session (Session) # – session to hook into

Discussed in Bootstrap scripts and extensions

on_window_create (self, window: Window) → None

mmethod [source] ¶

Provide a window hook previous to doing anything with a window.

Description#

This runs runs before anything is created in the windows, like panes.

Parameters

• window (Window) # – window to hook into

Discussed in Bootstrap scripts and extensions

after_window_finished (self, window: Window) → None

mmethod [source] ¶

Provide a window hook after creating the window.

Description#

This runs after everything has been created in the window, including the panes and all of the commands for the panes. It also runs after the options_after has been applied to the window.

Parameters

• window (Window) # – window to hook into

Discussed in Bootstrap scripts and extensions

before_script (self, session: Session) → None

mmethod [source] ¶

Provide a session hook after the workspace has been built.

Description#

This runs after the workspace has been loaded with tmuxp load. It augments instead of replaces the before_script section of the workspace data.

This hook provides access to the LibTmux.session object for any behavior that would be used in the before_script section of the workspace file that needs access directly to the session object. This runs after the workspace has been loaded with tmuxp load.

The hook augments, rather than replaces, the before_script section of the workspace. While it is possible to do all of the before_script workspace in this function, if a shell script is currently being used for the workspace, it would be cleaner to continue using the script in the before_section.

If changes to the session need to be made prior to anything being built, please use before_workspace_builder instead.

Parameters

• session (Session) # – session to hook into

reattach (self, session: Session) → None

mmethod [source] ¶

Provide a session hook before reattaching to the session.

Parameters

• session (Session) # – session to hook into

Discussed in Bootstrap scripts and extensions