If you like TypeScript and want your Karabiner configuration maintainable & type-safe, you probably want to use the custom configuration DSL / generator I created in rules.ts and utils.ts!
“This repo is incredible - thanks so much for putting it together! I always avoided Karabiner mostly because of its complicated configuration. Your project makes it so much easier to work with and so much more powerful. I'm geeking out on how much faster I'm going to be now.”
— @jhanstra (source)
- Install & start Karabiner Elements
- Clone this repository
- Make sure you call the directory karabiner, else the symlinking is not going to work
- If you made this mistake,
mv karabiner-config karabiner
- Delete the default
~/.config/karabinerfolder - Create a symlink with
ln -s ~/workspace/karabiner ~/.config(where~/workspace/karabineris your local path to where you cloned the repository) - Restart karabiner_console_user_server with
launchctl kickstart -k gui/`id -u`/org.pqrs.karabiner.karabiner_console_user_server
yarn install
to install the dependencies. (one-time only)
yarn run build
builds the karabiner.json from the rules.ts.
yarn run watch
watches the TypeScript files and rebuilds whenever they change.
Copyright (c) 2022 Maximilian Stoiber / 2024 Connor Fong (Amendments), licensed under the MIT license.