Metadata-Version: 2.4
Name: kitty-cheatsheet
Version: 0.2.0
Summary: Interactive keybinding cheatsheet for the kitty terminal emulator
Project-URL: Homepage, https://github.com/saforem2/kitty-cheatsheet
Project-URL: Repository, https://github.com/saforem2/kitty-cheatsheet
Author: Sam Foreman
License: MIT
License-File: LICENSE
Keywords: cheatsheet,keybindings,kitty,terminal
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# kitty-cheatsheet

Interactive keybinding and mouse binding cheatsheet for the [kitty](https://sw.kovidgoyal.net/kitty/) terminal emulator.

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

<table>
<tr>
<td><strong>Dark</strong></td>
<td><strong>Light</strong></td>
</tr>
<tr>
<td><img src="assets/cheatsheet-dark.png" alt="Dark theme screenshot" width="100%"></td>
<td><img src="assets/cheatsheet-light.png" alt="Light theme screenshot" width="100%"></td>
</tr>
</table>

## Install

```bash
pip install kitty-cheatsheet
```

## Usage

```bash
# 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:

```conf
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`:

```toml
config_dir = "~/.config/kitty"

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

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

## License

MIT
