terryops / Karabiner-Elements

The next generation Karabiner for macOS Sierra

Karabiner-Elements

Karabiner-Elements is the subset of the next generation Karabiner for macOS Sierra.

Project Status

Karabiner-Elements works fine.

You can download the latest Karabiner-Elements from https://pqrs.org/latest/karabiner-elements-latest.dmg

Usage

Detailed usage instructions are available here.

Features

• Simple key modification (change keys to another keys)
• Support Secure Keyboard Entry (eg. Terminal, Password prompt)
• Modifier flags sharing with all connected keyboards.

Limitations

• Karabiner-Elements cannot modify eject key due to the limitation of macOS API.
• Karabiner-Elements ignores the System Preferences > Keyboard > Modifier Keys... configuration.

How to build

System requirements:

• OS X 10.11+
• Xcode 8+
• Command Line Tools for Xcode
• Boost 1.61.0+ (header-only) http://www.boost.org/

Please install Boost into /opt/local/include/boost. (eg. /opt/local/include/boost/version.hpp)

Step 1: Getting source code

Clone the source from github.

git clone --depth 1 https://github.com/tekezo/Karabiner-Elements.git

Step 2: Building a package

cd Karabiner-Elements
make

The make script will create a redistributable Karabiner-Elements-VERSION.dmg in the current directory.