tmuxp.plugin.TmuxpPlugin.before_script

API reference · Markdown

tmuxp.plugin.TmuxpPlugin.before_script ( self , session : Session ) → None

method [source] ¶

method [source] ¶

tmuxp.plugin.TmuxpPlugin.before_script

Provide a session hook after the workspace has been built.

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

Discussed in Workspace Manager for Go (in development) , tmuxp load , Install and load a workspace , Go workspace internals , Go workspace builder behavior , Workspace hooks and builders , tmuxp compatibility and port status