Python API

method libtmux latest

Server.bind_key

Bind a key to a command via $ tmux bind-key.

Source and package

Qualified name: libtmux.Server.bind_key
Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py
Other languages: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScript RustGoJavaC#C++ Swift Kotlin Scala OCaml F# Clojure

bind_key ( self, key: str, command: str, key_table: str | None = None, note: str | None = None, repeat: bool | None = None, ) → None method [source] ¶

Examples#

>>> server.bind_key('F12', 'display-message test', key_table='root')
>>> server.unbind_key('F12', key_table='root')

Parameters

key (str) # – Key to bind (e.g. C-a, F12, M-x).
command (str) # – Tmux command to run when key is pressed.
key_table (str | None) # – Key table to bind in (-T flag). Defaults to prefix.
note (str | None) # – Note for the binding (-N flag).
repeat (bool | None) # – Allow the key to repeat (-r flag).

The tmux commands behind bind_key.

The C declarations in tmux that implement these commands.

Bind a key to a tmux command

Equivalents of Bind a key to a tmux command in other languages
Language	Equivalent
Erlang	`tmux_key:bind/3`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	no equivalent on `Server`
Rust	`server.Server.bind_key`
Go	`tmux.Server.BindKey`
Java	`io.github.libtmux.Keys.bind`
C#	`LibTmux.TmuxKeys.BindAsync`
C++	`libtmux::Server::bind_key`
Swift	no equivalent on `Server`
OCaml	No direct public OCaml equivalent is recorded for this operation.
Perl	No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.