Python API

method libtmux stable

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: PowerShell Julia Ruby Lua TypeScript Rust GoJavaC# C++ Swift Kotlin Scala F#

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.

tmux command list-keys

In other ports List the key bindings

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
No source-verified Lua equivalent is recorded for this operation.
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
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.