🎹 Karabiner-Elements Configuration 🎹

Created with ❤️ by Dr Liang Jin

🚀 Quick Start

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/drliangjin/karabiner.d/HEAD/tools/install.sh)"

---

Introduction | Features | Installation | Resources | FAQ

---

📜 Introduction

This is my configuration for Karabiner-Elements, a powerful and low-level keyboard manipulation tool. Karabiner is one of the main reasons I choose to stay with macOS while there are too many troubles to implement the same/similar layout in GNU/Linux distributions (I really tried...maybe later...).

✨ Features

Modifiers

From	To	Press Alone	Device
Ctrl	Hyper	F17	-
Command	Option/Alt	F18	Apple Keyboard
Option/Alt	Command	F19	Apple Keyboard
Caps Lock	Ctrl	ESC	-
Enter	Ctrl	Enter	-
Shift	Shift	( )	-

Switchers (mimic Ubuntu Unity)

From	To	Press Alone	Device
Command + Tab	Option/Alt + Tab	-	-
Shift + Command + Tab	Shift + Option/Alt + Tab	-	-

Launchers (mimic Ubuntu Unity)

Dash (mimic Ubuntu Unity)

Editing (mimic Emacs)

Key	From	To (key_code)	Function
Ctrl g	NA		Cancel
Ctrl w			Cut
Ctrl y			Paste
Ctrl /			Undo
Ctrl s			Find
Ctrl d	NA		Forward Delete Char
Ctrl h	NA		Backward Delete Char
Ctrl k	NA		Forward Kill Line
Ctrl u	NA		Backward Kill Line
Ctrl f			Forward Move Char
Ctrl b			Backward Move Char
Ctrl n			Next Line
Ctrl p			Previous Line
Ctrl a			Begining of Line
Ctrl e			End of Line
Ctrl v			Next Page
Ctrl i			Indent
Option/Alt g			NA
Option/Alt w			Copy
Option/Alt y			NA
Option/Alt /			Redo
Option/Alt d			Forward Kill Word
Option/Alt h			Backward Kill Word
Option/Alt k			Forward Copy Line
Option/Alt u			Backward Copy Line
Option/Alt f			Forward Move Word
Option/Alt b			Backward Move Word
Option/Alt n			NA
Option/Alt p			NA
Option/Alt a			NA
Option/Alt e			NA
Option/Alt v			Previous Page
Option/Alt i			NA

File (mimic Emacs)

From	To	Press Alone	Device
Ctrl z +	Option/Alt + Tab	-	-
Ctrl z + Tab	Option/Alt + Tab	-	-

🛠️ Installation

brew cask install karabiner-elements

📢 Updates

🚧 Development

TODO

• macOS workspace shortcuts (ctrl left_arrow & ctrl right_arrow, ctrl #)
• macOS dock shortcuts (ctrl F3, then left_arrow or right_arrow to move, return to open an item)
• implement Tab as a modifier when hold down
• Ctrl + j and Ctrl + m
• Cycle clipboard history using Option/Alt + y
• delete to kill/cut (select text and cut, for words and lines)
• undo ( Ctrl + / ) and redo ( Option/Alt + / )
• implement to_if_held_down and to_after_key_up, see complex modifications example
• implement virtual modifiers using set_variable and variable_if, see virtual-modifier from pqrs.org

🎖️ Acknowledgement

📖 Resources

• Text System Defaults and Key Bindings from Apple Developer
• Cocoa Text System by Jacob Rus
• Selector by Jacob Rus
• Default Mac OS X System Key Bindings
• A short article about emacs keybindings in macOS
• ttscoff's KeyBindings
• Emacs Keybindings Everywhere in Mac OS X by lelf
• Ukelele
• Mac OS X: Keybinding DefaultKeyBinding.dict Problems by Xah Lee

🙋‍♀️ FAQ