Python

Choose a port 22

Scripting & web

RubyNo matching page

LuaNo matching page

JuliaNo matching page

TypeScriptNo matching page

PerlNo matching page

Compiled & native

RustNo matching page

GoNo matching page

C++No matching page

Common LispNo matching page

SwiftNo matching page

OCamlNo matching page

HaskellNo matching page

JVM

JavaNo matching page

KotlinNo matching page

ScalaNo matching page

ClojureNo matching page

.NET

C#No matching page

F#No matching page

PowerShellNo matching page

BEAM

ErlangNo matching page

ElixirNo matching page

tmux

Packages

Packages and source 10

Source

libtmuxtmux-python/libtmux pytest pluginplugin · src/libtmux/pytest_plugin.py libtmux.testmodule · src/libtmux/test libtmux-mcplibtmux-mcp/src/libtmux_mcp libtmux-mcptmux-python/libtmux-mcp tmuxptmuxp/src/tmuxp tmuxptmux-python/tmuxp

Packages

libtmux-mcpPyPI

Python · tmux-python/libtmux

Auto Light Dark

Core Library0.xAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

Other references Upstream reference

0.x Released; the API may change. Read more

MCP Tools for connected assistants

Home Guides Topics Examples Tools Prompts Resources API Reference

pre-alpha Early development; expect breaking changes. Read more

Workspace Manager Repeatable development environments

Home Guides Topics Examples CLI Manual API Reference Configuration Internals

1.x Released; the API may change. Read more

latest

Current version

English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

Python API

method libtmux latest

HooksMixin.show_hooks

Return a dict of hooks for the target.

Source and package

Qualified name: libtmux.hooks.HooksMixin.show_hooks
Module: libtmux.hooks
Declared in: HooksMixin
Package: libtmux
Source: src/libtmux/hooks.py

show_hooks ( self, global_: bool | None = False, scope: OptionScope | _DefaultOptionScope | None = DEFAULT_OPTION_SCOPE, ) → HookDict method [source] ¶

Examples#

>>> session.set_hook('session-renamed[0]', 'display-message "test"')
Session($...)

>>> hooks = session.show_hooks()
>>> isinstance(hooks, dict)
True

>>> 'session-renamed[0]' in hooks
True

>>> session.unset_hook('session-renamed')
Session($...)

Parameters

global_ (bool | None) # – Pass -g flag for global hooks, default False.
scope (OptionScope | _DefaultOptionScope | None) # – Hook scope (Server/Session/Window/Pane), defaults to object's scope.

Returns

HookDict Dictionary mapping hook names to their values.

tmux command#

The tmux commands behind show_hooks.

tmux C API#

The C declarations in tmux that implement these commands.

cmd_show_hooks_entry cmd_show_options_exec

tmux hooks#

Events that run tmux commands, with the scope each hook belongs to and where tmux fires it.

Reference preview