https://github.com/bhrutledge/zkeys
Display Zsh key bindings in more human-readable formats
https://github.com/bhrutledge/zkeys
Last synced: about 1 year ago
JSON representation
Display Zsh key bindings in more human-readable formats
- Host: GitHub
- URL: https://github.com/bhrutledge/zkeys
- Owner: bhrutledge
- License: mit
- Created: 2021-07-03T09:58:06.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-27T10:17:56.000Z (almost 5 years ago)
- Last Synced: 2025-06-23T04:05:29.290Z (about 1 year ago)
- Language: Python
- Homepage: https://pypi.org/project/zkeys/
- Size: 49.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# zkeys
Display Zsh key bindings in more human-readable formats.
For example, print a table of key bindings, sorted by widget (i.e. function):
```text
% zkeys
...
^B backward-char
^[[D backward-char
^[OD backward-char
^? backward-delete-char
^H backward-delete-char
^[^? backward-kill-word
^[^H backward-kill-word
^[B backward-word
^[b backward-word
^A beginning-of-line
^[OH beginning-of-line
^[C capitalize-word
^[c capitalize-word
^L clear-screen
^[^L clear-screen
...
```
Instead of:
```text
% bindkey
"^@" set-mark-command
"^A" beginning-of-line
"^B" backward-char
"^D" delete-char-or-list
"^E" end-of-line
"^F" forward-char
"^G" send-break
"^H" backward-delete-char
...
"^[B" backward-word
"^[C" capitalize-word
"^[D" kill-word
"^[F" forward-word
...
```
Run `zkeys -h` to see more sorting and grouping options.
By default, `zkeys` runs `bindkey -L` in a Zsh subprocess. It can also read from standard input, which is faster, and enables displaying the current shell configuration:
```sh
bindkey -L | zkeys
```
To learn about Zsh key bindings, see:
-
-
## Installing
Requires Python 3.8 or newer.
Install the latest release from [PyPI](https://pypi.org/project/zkeys/) using [pipx](https://pypa.github.io/pipx/) (recommended) or [pip](https://pip.pypa.io/en/stable/):
```sh
pipx install zkeys
python3 -m pip install -U zkeys
```
To install the latest version from GitHub, replace `zkeys` with `git+https://github.com/bhrutledge/zkeys.git`.