Skip to main content

kitty-cheatsheet

Interactive keybinding and mouse binding cheatsheet for the kitty terminal emulator.

Parses your kitty config files directly and renders a colorized, searchable, side-by-side cheatsheet in your terminal.

Dark Light
Dark theme screenshot Light theme screenshot

Install

pip install kitty-cheatsheet

Usage

# Launch the interactive TUI
kitty-cheatsheet

# Point at a custom config directory
kitty-cheatsheet --config-dir ~/.config/kitty

# Plain text output (also auto-detected when piped)
kitty-cheatsheet --no-color
kitty-cheatsheet | grep scroll

From kitty

Add a keybinding to launch the cheatsheet as an overlay:

map kitty_mod+m launch --type=overlay kitty-cheatsheet

TUI Controls

Key Action
j / k Scroll up/down
d / u Half-page down/up
g / G Jump to top/bottom
/ Search (live filtering)
Escape Clear search / quit
q Quit

Configuration

Optional config file at ~/.config/kitty-cheatsheet/config.toml:

config_dir = "~/.config/kitty"

[colors.modifiers]
kitty_mod = "#FF69B4"
cmd = "#00CED1"

[prettify]
"kitten ~/.config/kitty/" = "⚙ "

License

MIT

Metadata

Release files for kitty-cheatsheet 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kitty-cheatsheet 0.2.0
File Size Uploaded
kitty_cheatsheet-0.2.0.tar.gz 1.1 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for kitty-cheatsheet 0.2.0
File Interpreter ABI Platform
kitty_cheatsheet-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 1.1 MB

Release files / kitty_cheatsheet-0.2.0.tar.gz

Download URL kitty_cheatsheet-0.2.0.tar.gz
Size 1.1 MB
Tags Source
SHA-256 checksum
How to use checksums
799ef274b54ccb1d54eb1b755e2d5c0b843509f68cfd782018da0954335e232f
BLAKE2b-256 checksum
How to use checksums
40ce37bcbbb02d0c91d14345cb47adff2f07b6eb71675e3690749abe0539e84f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / kitty_cheatsheet-0.2.0-py3-none-any.whl

Download URL kitty_cheatsheet-0.2.0-py3-none-any.whl
Size 12.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6fa767f851a313d9cdfa4854c53dfd1eb67143ccacbf8c84de6779fc2f26fbb5
BLAKE2b-256 checksum
How to use checksums
cd3c057b59fc28616fb8409f284a5d5e7397de71571f20045c987e3ec7c58ae8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page