README.md

• Installation
• Open Karabiner-Elements
• Quit Karabiner-Elements
• Uninstall Karabiner-Elements
• Change Key

Installation

Download Karabiner-Elements package from https://pqrs.org/latest/karabiner-elements-latest.dmg

Open dmg file and then open the installer.

Karabiner-Elements and Karabiner-EventViewer will be installed into Launchpad.

Open Karabiner-Elements

Open Karabiner-Elements from Launchpad.

The preferences window will be opened.

Quit Karabiner-Elements

You can quit Karabiner-Elements by the Quit Karabiner-Elements button.

Uninstall Karabiner-Elements

You can uninstall Karabiner-Elements from Misc tab.

How to configure Karabiner-Elements

At the moment, you have to edit the configuration file by hand.

The configuration file is located in ~/.karabiner.d/configuration/karabiner.json

You have to create this file manually.

How to create karabiner.json

Open your terminal and issues these commands in the give order.

1. mkdir -p ~/.karabiner.d/configuration/
2. cd ~/.karabiner.d/configuration/
3. touch karabiner.json
4. open karabiner.json

This should open karabiner.json in your default text editor.

An example of karabiner.json

karabiner.json uses json syntax. If you are not familiar with it, it may help to read on it before hand.

Following is an example configuration. It maps Caps Lock ⇪ key to Delete ⌫ key.

{
    "profiles": [
        {
            "name": "Default profile",
            "selected": true,
            "simple_modifications": {
                "caps_lock": "delete_or_backspace"
            }
        }
    ]
}

All maping rules must be placed between "simple_modifications": { and }. Rules are separated by comma.

Lets say, in addition to Caps Lock mapping, we want to map left Command ⌘ key to Control ⌃ key, we will add new rule under caps_lock rule.

{
    "profiles": [
        {
            "name": "Default profile",
            "selected": true,
            "simple_modifications": {
                "caps_lock": "delete_or_backspace",
                "left_command": "left_control"
            }
        }
    ]
}

The key definition

You need key definitions to map keys. For example you should know Caps Lock ⇪ key is caps_lock.

The keys (eg. "caps_lock") are defined in types.hpp.

https://github.com/tekezo/Karabiner-Elements/blob/master/src/share/types.hpp#L177-L369

Typical configuration files

Following are few configuration files that will help you get started. Use them as it is or mix the rules as per your need.

• Change caps lock to delete
• Change caps lock to escape
• Swap caps lock and delete
• Swap caps lock and escape
• Change section key § with accent key `
• Change menu key ≣ with Option (alt) ⌥ key

Swapping Section/Paragraph § key on non-US keyboards

Most non US keyboards have a § key paired with ± or $ or something else.

UK Keyboard

Danish Keyboard

Arabic Keyboard

German Keyboard

Most users swap § with whatever key is right next to shift ⇧ key.

Following is sample configuration that swaps those two keys.

{
    "profiles": [
        {
            "name": "Default profile",
            "selected": true,
            "simple_modifications": {
                "non_us_backslash": "grave_accent_and_tilde",
                "grave_accent_and_tilde" : "non_us_backslash"
            }
        }
    ]
}

This will give you following mapping,

Keyboard	Before	After
UK or Arabic	§	`
UK or Arabic	`	§
UK or Arabic	±	~
UK or Arabic	~	±
Danish	§	>
Danish	>	§
Danish	$	<
Danish	<	$
German	^	<
German	<	^