Python

Choose a port 15

Scripting & web

RubyNo matching page

JuliaNo matching page

Compiled & native

C++No matching page

JVM

JavaNo matching page

KotlinNo matching page

ScalaNo matching page

.NET

C#No matching page

F#No matching page

PowerShellNo matching page

tmux

GitHub

Source on GitHub 3

Core Library

libtmuxtmux-python/libtmux

MCP

libtmux-mcptmux-python/libtmux-mcp

Workspace Manager

tmuxptmux-python/tmuxp

Python · tmux-python/libtmux

Packages

Packages on PyPI 3

Core Library

MCP

libtmux-mcpPyPI

Workspace Manager

Python · PyPI

Auto Light Dark

Core LibrarystableAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

Other references Upstream reference

stable Stable release on its package registry. 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

stable Stable release on its package registry. Read more

stable

Current version

English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Python API

method libtmux stable

Pane.set_hook

Set hook for tmux target.

Source and package

Qualified name: libtmux.Pane.set_hook
Module: libtmux
Declared in: Pane
Package: libtmux
Source: src/libtmux/hooks.py
Other languages: PowerShell Julia Ruby LuaTypeScriptRustGo Java C# C++ Swift Kotlin Scala F#

set_hook ( self, hook: str, value: int | str, unset: bool | None = None, run: bool | None = None, append: bool | None = None, g: bool | None = None, global_: bool | None = None, scope: OptionScope | _DefaultOptionScope | None = DEFAULT_OPTION_SCOPE, ) → Self method [source] ¶

Inherited from libtmux.hooks.HooksMixin

Description#

Wraps $ tmux set-hook <hook> <value>.

Parameters

hook (str) # – hook to set, e.g. 'aggressive-resize'
value (int | str) # – hook command.
unset (bool | None) #
run (bool | None) #
append (bool | None) #
g (bool | None) #
global_ (bool | None) #
scope (OptionScope | _DefaultOptionScope | None) #

Raises

tmux catalog Hooks

Discussed in Options and hooks

In other ports Bind a command to a pane hook

PowerShell
No source-verified PowerShell equivalent is recorded for this operation.
Julia
No source-verified Julia equivalent is recorded for this operation.
Ruby
No source-verified Ruby equivalent is recorded for this operation.
Lua
libtmux.Pane:set_hook
TypeScript
pane.Pane.setHook
Rust
pane.Pane.set_hook
Go
tmux.Pane.SetHook
Java
reached through Pane.hooks, whose Hooks carries the write
C#
reached through Pane.Hooks, whose TmuxHooks carries the write
C++
no equivalent on Pane
Swift
Server.setHook(_:to:at:in:)
Kotlin
No source-verified Kotlin equivalent is recorded for this operation.
Scala
No source-verified Scala equivalent is recorded for this operation.
F#
No source-verified F# equivalent is recorded for this operation.

Reference preview Open reference