KaraYAML

A declarative YAML layer for Karabiner‑Elements on macOS.

KaraYAML turns the time‑consuming “click and JSON edit” workflow into a single YAML file you can version‑control.
Define your shortcuts once, run a command, and Karabiner‑Elements reloads with a fresh config every time.

---

Website & docs

Looking for features, quick start, CLI commands, schema, or "how it works"? Visit the website for the full documentation:

• Open the website: https://karayaml.dev

---

Building from source

git clone https://github.com/swarupdonepudi/karayaml
cd karayaml
make build          # Darwin ARM64 and AMD64 binaries in ./build

---

Make targets

TextEdit editor test (bypass VS Code)

Use this to test the edit flow with macOS TextEdit and ensure the CLI waits for the document window to close (Cmd+W) instead of requiring you to quit TextEdit:

make text
# or the explicit target name
make textedit-test

This target runs the edit command with the environment configured to force TextEdit:

• VISUAL is cleared and EDITOR is set to run the AppleScript at scripts/textedit_wait.applescript via osascript.
• Works on macOS only. Close the TextEdit window to let the CLI continue and reload configuration.

---

Contributing

Issues and PRs are welcome. Please:

1. Open an issue first for large changes.
2. Run make fmt vet test before pushing.
3. Keep commit messages concise and conventional.

---

License

MIT © Swarup Donepudi