Show hooks

show_hooks

show_hooks
readonly tool

List configured tmux hooks at the given scope.

Returns:

HookListResult

Use when you need to enumerate every hook configured on a target — the human user’s tmux config, an inherited team setup, or a session that another tool may have touched.

Side effects: None. Readonly.

Parameters

Parameter

Type

Required

Default

Description

scope

enum

no

Hook scope (server/session/window/pane). Defaults to the calling object’s scope when a target is given. One of: 'server', 'session', 'window', 'pane'.

target

str

no

Target identifier. For session scope: session name. For window scope: window ID. For pane scope: pane ID. Requires scope.

global_

bool

no

False

Pass -g to query global hooks. Default False.

socket_name

str

no

tmux socket name.