Skip to main content

Interactive keybinding cheatsheet for the kitty terminal emulator

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kitty_cheatsheet-0.2.0.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kitty_cheatsheet-0.2.0-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file kitty_cheatsheet-0.2.0.tar.gz.

File metadata

  • Download URL: kitty_cheatsheet-0.2.0.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using 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}

File hashes

Hashes for kitty_cheatsheet-0.2.0.tar.gz
Algorithm Hash digest
SHA256 799ef274b54ccb1d54eb1b755e2d5c0b843509f68cfd782018da0954335e232f
MD5 581212ea3547fb3063d850f9501b54d8
BLAKE2b-256 40ce37bcbbb02d0c91d14345cb47adff2f07b6eb71675e3690749abe0539e84f

See more details on using hashes here.

File details

Details for the file kitty_cheatsheet-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: kitty_cheatsheet-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using 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}

File hashes

Hashes for kitty_cheatsheet-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6fa767f851a313d9cdfa4854c53dfd1eb67143ccacbf8c84de6779fc2f26fbb5
MD5 68aa86c443ef3f9830d901492a20baef
BLAKE2b-256 cd3c057b59fc28616fb8409f284a5d5e7397de71571f20045c987e3ec7c58ae8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page