KoalaKeys 

KoalaKeys 是一个轻量级命令行工具，可将结构化的 YAML 文件转换为便携、交互式 HTML 键盘快捷键速查表。它专为开发者、设计师和高阶用户设计，帮助你将常用快捷键整理成可离线使用的网页，随时随地快速查阅。

核心理念：快捷键是生产力的杠杆，值得被系统化管理。

核心功能

• YAML 驱动：用纯文本定义快捷键，版本友好，易于协作
• 交互式键盘布局：悬停快捷键时，对应按键实时高亮
• 多系统/多语言支持：
  • 操作系统：macOS（Darwin）、Linux、Windows
  • 键盘布局：US、UK、DE（德语）、FR（法语）、ES（西班牙语）、DVORAK
• 智能组织：
  • 按功能分类（如“导航”、“编辑”、“调试”）
  • 每个快捷键附带清晰描述
• 全局搜索与索引：
  • 自动生成 index.html 汇总所有速查表
  • 支持关键词搜索，快速定位命令

快速开始

1. 安装依赖

git clone https://github.com/rtuszik/KoalaKeys
cd KoalaKeys
uv sync --locked  # 或使用其他 Python 虚拟环境工具

2. 配置输出目录

在项目根目录创建 .env 文件：

CHEATSHEET_OUTPUT_DIR=./output

3. 创建速查表（YAML 示例）

在 cheatsheets/ 目录下新建 macos-vscode.yaml：

# yaml-language-server: $schema=https://rtuszik.github.io/KoalaKeys/schema/cheatsheet.schema.json
name: "VS Code (macOS)"
system: "Darwin"
keyboard_layout: "US"
categories:
  - name: "Navigation"
    shortcuts:
      - key: "CMD + P"
        description: "快速打开文件"
      - key: "CTRL + G"
        description: "跳转到行号"
  - name: "Editing"
    shortcuts:
      - key: "CMD + D"
        description: "选中下一个匹配项"

✅ 验证格式：YAML 文件首行已内置 schema 引用，支持 VS Code、Neovim 等编辑器自动校验。

4. 生成 HTML

uv run src/generate_cheatsheet.py

生成的文件将保存在 ./output/，打开 output/index.html 即可浏览。

为什么选择 KoalaKeys？

• 便携离线：生成纯 HTML/CSS/JS，无需服务器，可存 U 盘或部署到任意静态站点
• 版本可控：YAML 文件可纳入 Git，团队共享快捷键规范
• 高度可定制：通过修改 YAML 即可适配任意软件或工作流
• 社区驱动：开源项目，欢迎贡献新速查表

适用场景

• 开发者：整理 VS Code、Vim、Terminal 快捷键
• 设计师：归档 Figma、Photoshop、Blender 操作
• 教学：为新手提供交互式学习材料
• 个人知识管理：将零散快捷键转化为结构化资产