# tmux list-keys

Source: https://libtmux.org/en/tmux/3.2a/manual/list-keys/

> List key bindings.

List key bindings.

## Syntax

```tmux-usage
tmux list-keys [-1aN] [-P prefix-string] [-T key-table] [key]
```

Alias: `lsk`.

## Behavior

List key bindings. There are two forms: the default lists keys as [`bind-key`](https://libtmux.org/en/tmux/3.2a/manual/bind-key/) commands; `-N` lists only keys with attached notes and shows only the key and note for each key.

With the default form, all key tables are listed by default. `-T` lists only keys in `key-table`.

With the `-N` form, only keys in the *root* and *prefix* key tables are listed by default; `-T` also lists only keys in `key-table`. `-P` specifies a prefix to print before each key and `-1` lists only the first matching key. `-a` lists the command for keys that do not have a note rather than skipping them.

## C implementation

Internal declarations in tmux 3.2a:

* [`cmd_list_keys_entry`](https://libtmux.org/en/tmux/3.2a/reference/c-variable-cmd_list_keys_entry/)
* [`cmd_list_keys_exec`](https://libtmux.org/en/tmux/3.2a/reference/c-function-cmd-list-keys-c-cmd_list_keys_exec/)

## Use from a library

Each API describes its own defaults, errors and execution model.

* [Python](https://libtmux.org/en/py/latest/reference/libtmux-server-list_keys/)
* [Go](https://libtmux.org/en/go/latest/reference/tmux-server-listkeys/)
* [Java](https://libtmux.org/en/java/latest/reference/io-github-libtmux-keys-keys-list/)
* [C#](https://libtmux.org/en/csharp/latest/reference/libtmux-tmuxkeys-getallasync/)

tmux sources and license

Syntax comes from `tmux 3.2a list-commands`. See the [global options](https://libtmux.org/en/tmux/3.2a/manual/full/#DESCRIPTION) for sockets and configuration, and [command syntax and targets](https://libtmux.org/en/tmux/3.2a/manual/full/#COMMANDS).

Behavior is taken from the [tmux 3.2a manual](https://github.com/tmux/tmux/blob/85893888497c5077979bc7557fb970ee5e3d13d9/tmux.1).

[Command declaration](https://github.com/tmux/tmux/blob/85893888497c5077979bc7557fb970ee5e3d13d9/cmd-list-keys.c#L36)

```
Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>

Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
```