Python API

method libtmux latest

Server.list_keys

List key bindings via $ tmux list-keys.

Source and package

Qualified name: libtmux.Server.list_keys
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 Rust GoJavaC# C++ Swift Kotlin Scala OCaml F# Clojure

list_keys ( self, key_table: str | None = None, format_: str | None = None, ) → list[str] method [source] ¶

Examples#

>>> result = server.list_keys()
>>> isinstance(result, list)
True

Parameters

key_table (str | None) # – Filter by key table (-T flag).
format_ (str | None) # – Custom output format applied to each line (-F flag). Requires tmux 3.7+; warns and is ignored on older tmux.

Returns

list[str] Key binding lines.

The tmux commands behind list_keys.

The C declarations in tmux that implement these commands.

List the key bindings

Equivalents of List the key bindings in other languages
Language	Equivalent
Erlang	`tmux_key:listing/1`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	no equivalent on `Server`
Rust	no equivalent on `Server`
Go	`tmux.Server.ListKeys`
Java	`io.github.libtmux.Keys.list`
C#	`LibTmux.TmuxKeys.GetAllAsync`
C++	no equivalent on `Server`
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#.