Initial commit

2026-09-06 01:06:40 +08:00
commit 57c4e80f0d
69 changed files with 20940 additions and 0 deletions
@@ -0,0 +1,23 @@
+# Команды утилиты katana.py
+
+Справочник команд и аргументов.
+Все команды идут через транзакцию `begin → data → commit → save` и безопасны: печать не прерывается, прошивка остаётся живой.
+Исключение — `macro set`/`macro clear`: вендор после записи макросов save не делает (подробности в [PROTOCOL.md](../PROTOCOL.md)).
+Низкоуровневое описание транзакций — в [PROTOCOL.md](../PROTOCOL.md).
+
+Режимы подсветки и их аргументы вынесены в отдельный документ: [COLOR-MODES.md](../COLOR-MODES.md).
+
+## Состав справочника
+
+| Документ                              | Тема                                                                          |
+| ------------------------------------- | ----------------------------------------------------------------------------- |
+| [colors.md](colors.md)                | Именованные цвета CSS вместо `RRGGBB`.                                        |
+| [keys.md](keys.md)                    | Имена клавиш: канонические, символы, синонимы, hex-индексы.                   |
+| [paint.md](paint.md)                  | `paint` — per-key раскраска и shorthand-алиасы (`--wasd`, `--row1`…`--row6`). |
+| [scan.md](scan.md)                    | `scan` — визуальный перебор режимов.                                          |
+| [raw.md](raw.md)                      | `raw` — произвольный payload для экспериментов.                               |
+| [remap.md](remap.md)                  | `remap` — переназначение клавиш на мышь, шорткаты редактора, мультимедиа, горячие клавиши и макросы. |
+| [macro.md](macro.md)                  | `macro` — запись макросов, работа с вендорским XML.                           |
+| [apply.md](apply.md)                  | `apply` — применение YAML-конфига целиком (профиль настроек).                 |
+| [commands.md](commands.md)            | Команды без аргументов: `keys`, `reset`, `off`, `default`.                    |
+| [troubleshooting.md](troubleshooting.md) | Что делать, если команда отклоняется или прошивка залипла.                 |