Karabiner-Elements

Breaking changes introduced by the version upgrade

Mon, 01 Jan 0001 00:00:00 +0000

In principle, Karabiner-Elements is developed to maintain compatibility with past versions. However, breaking changes may be made for reasons such as keeping up with macOS updates. This page provides information regarding those changes.

Karabiner-Elements 15.1.0

The following changes have been made due to the update where the virtual keyboard now uses the Vendor ID and Product ID of the Apple Aluminum USB Keyboard (A1243):

Modifiers

The virtual keyboard settings under System Settings > Keyboard > Keyboard Shortcuts... > Modifier Keys will now be shared with those of the Apple Aluminum USB Keyboard (A1243). If you’ve used this keyboard before, it’s worth reviewing your settings.

Function Keys

The “Use all F1, F2, etc. keys as standard function keys” setting now needs to be changed from System Settings.
For the F1-F12 key events sent by Karabiner-Elements, macOS will convert them once again into media keys (e.g., sending F10 will trigger mute). If you want to send F1-F12 as-is using Complex Modifications, you will need to send fn+F1-F12 through Karabiner-Elements.
Details on changing to function keys

Fn Key (Globe Key)

In previous versions, fn+arrow keys were converted to page up, page down, home, and end, but this behavior has been discontinued.

Required macOS settings

Mon, 01 Jan 0001 00:00:00 +0000

Under normal circumstances, there is no need to read this page, as the necessary settings have already been made during the initial setup.

However, we explain the macOS settings made during the initial setup of Karabiner-Elements for the following purposes:

If you want to check the macOS settings made during the initial setup.
If Karabiner-Elements is not working properly and you want to ensure that the macOS settings are correct.

Enable background services

Karabier-Elements has processes running constantly in the background, that handle input events. You have to keep the background items enabled in macOS System Settings > General > Login Items.

Driver alert keeps showing up

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements provides a driver extension so it can offer a virtual keyboard and mouse. During setup you need to enable this driver extension.

Normally it’s enough to turn on the toggle in System Settings. However, some people report that the extension never appears in System Settings.

In this case, Karabiner-Elements displays the following alert.

Please grant permission for a Driver Extension
Waiting for a connection to the IOKit service

Team ID and Bundle ID

This usually happens because third-party security software blocks the driver extension from loading. If that’s the case, add the driver to the whitelist in your security software so the driver extension can load.

About "Device is ignored temporarily" alert

Mon, 01 Jan 0001 00:00:00 +0000

Note

This limitation was removed in v15.8.0. The content written here applies to older versions.

“Device is ignored temporarily” alert will be shown in any of the following cases:

If you hold keys or buttons down before Karabiner-Elements open the device.
Your device sends unintented key up events regardless you do not touch the keys.
(e.g., Swiftpoint ProPoint sends key up events of the music play key periodically.)

Press the described key or button again to dismiss the alert.

cg_event_double_click

Mon, 01 Jan 0001 00:00:00 +0000

Send double click event by software. cg_event_double_click ensures that the click event occurs at the same location even if the mouse cursor is moving between the first click and the second click.

Low responsiveness

This configuration is highly specific.

This event will be lagged since it is sent by software implementation. It is better to send pointing_button::button1 twice instead of cg_event_double_click to get a better response.

Only use it if you absolutely must trigger double-click events without sending regular button events.

Change a key to another key

Mon, 01 Jan 0001 00:00:00 +0000

You can change keys from the Simple Modifications tab.

First, select the target device, then choose the keys you want to modify.
(The following example changes the right command key to the mouse button 3.)
Confirm the result using Karabiner-EventViewer.

Tip

You can find the key name by Karabiner-EventViewer.

File locations

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements configuration file paths:

~/.config/karabiner/karabiner.json
- Main configuration file.
  Karabiner-Elements watches this file and reload it automatically when it is updated.
~/.config/karabiner/assets/complex_modifications
- Imported complex_modifications files.
  You can use them in Karabiner-Elements Settings > Complex Modifications > Add predefined rule.

Tip: file update detection and automatic reload

Karabiner-Elements watches ~/.config/karabiner/karabiner.json and reloads it if updated.

The mechanism is that Karabiner-Elements watches the parent directory ~/.config/karabiner by using the File System Events API.
Thus, Karabiner-Elements fails detecting file updates after you change the parent directory (e.g., recreate the parent directory).

from.any

Mon, 01 Jan 0001 00:00:00 +0000

from.any is a way to match all events of the specified types. Its two main uses are:

Combine it with to.from_event to create pass-through mode
Combine it with filters such as variable_if to disable key events under specific conditions.

You can use from.any as follows.
These matches all key codes, consumer key codes or pointing buttons.

"any": "key_code"
"any": "consumer_key_code"
"any": "pointing_button"

Caution

Be careful using "any": "pointing_button".
You may lose the left click button and system will be unusable.

frontmost_application_if, frontmost_application_unless

Mon, 01 Jan 0001 00:00:00 +0000

Change an event if/unless the frontmost application is the specified application.

Example

Change control-h key to delete_or_backspace except in Terminal.

💡 How to use this example

{
    "description": "Change control-h to delete_or_backspace except in Terminal",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "h",
                "modifiers": {
                    "mandatory": ["control"],
                    "optional": ["any"]
                }
            },
            "to": [{ "key_code": "delete_or_backspace" }],
            "conditions": [
                {
                    "type": "frontmost_application_unless",
                    "bundle_identifiers": ["^com\\.apple\\.Terminal$"]
                }
            ]
        }
    ]
}

Specification

{
    "type": "frontmost_application_if",
    "bundle_identifiers": [
        bundle identifier regex,
        bundle identifier regex,
        ...
    ],
    "file_paths": [
        file path regex,
        file path regex,
        ...
    ]
}

Name	Required	Description
`type`	Required	`"frontmost_application_if"` or `"frontmost_application_unless"`
`bundle_identifiers`	Optional	Bundle identifier regexs such as `["^com\\.apple\\.Terminal$", "^com\\.googlecode\\.iterm2$"]`
`file_paths`	Optional	File path regexs such as `["/Finder$"]`
`description`	Optional	A human-readable comment

Multiple bundle identifiers or file paths

Multiple entries in bundle_identifiers and file_paths are joined by “or”.

How to change mouse buttons

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements does not modify mouse devices by default.

You have to enable your mouse on Karabiner-Elements Settings > Devices.
Then, use Simple Modifications to assign a key to a button or use Complex Modifications for more advanced usage.

Installation

Mon, 01 Jan 0001 00:00:00 +0000

Some operations are required to grant proper permission from macOS to Karabiner-Elements. Follow these instructions to set up Karabiner-Elements.

Install Karabiner-Elements

Open the downloaded file.
Open the Karabiner-Elements.pkg.
The installer will be opened. Install Karabiner-Elements.

After installation, you’ll need to grant the necessary permissions for Karabiner-Elements to function. This is part of macOS’s protection mechanism to prevent applications from accessing information without user consent. There are a few required steps, so please follow the instructions.

Installed files

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements installs files into the following locations.

System files

/Applications/Karabiner-Elements.app
/Applications/Karabiner-EventViewer.app
/Applications/.Karabiner-VirtualHIDDevice-Manager.app
/Library/Application Support/org.pqrs/Karabiner-Elements
/Library/Application Support/org.pqrs/Karabiner-DriverKit-VirtualHIDDevice
/Library/Application Support/org.pqrs/config
/Library/Application Support/org.pqrs/tmp
/var/log/karabiner

Note

If you are using Karabiner-Elements 14.13.0 or earlier, there are also files located in the following places.

/Library/LaunchDaemons/org.pqrs.karabiner.karabiner_grabber.plist
/Library/LaunchDaemons/org.pqrs.karabiner.karabiner_kextd.plist
/Library/LaunchDaemons/org.pqrs.karabiner.karabiner_observer.plist
/Library/LaunchAgents/org.pqrs.karabiner.agent.karabiner_grabber.plist
/Library/LaunchAgents/org.pqrs.karabiner.agent.karabiner_observer.plist
/Library/LaunchAgents/org.pqrs.karabiner.karabiner_console_user_server.plist
/Library/LaunchAgents/org.pqrs.karabiner.karabiner_session_monitor.plist

User files

~/.config/karabiner
~/.local/share/karabiner
~/Library/Preferences/org.pqrs.Karabiner-Elements.Settings.plist
~/Library/Preferences/org.pqrs.Karabiner-EventViewer.plist
~/Library/Preferences/org.pqrs.Karabiner-Menu.plist
~/Library/Preferences/org.pqrs.Karabiner-MultitouchExtension.plist
~/Library/Preferences/org.pqrs.Karabiner-Updater.plist

Warning

If you want to remove Karabiner-Elements, you have to use uninstaller.

Letter key holding modifier

Mon, 01 Jan 0001 00:00:00 +0000

Switch to the app launcher when the u key is held down.

u (hold for 250 ms) + s: Open Safari
u (hold for 250 ms) + t: Open Terminal

JavaScript version

💡 How to use this example

// JavaScript must be written in ECMAScript 5.1.

function main() {
    const definitions = [
        { from: 's', to: 'com.apple.Safari' },
        { from: 't', to: 'com.apple.Terminal' },
    ]

    const manipulators = [
        {
            type: 'basic',
            from: {
                key_code: 'u',
                modifiers: { optional: ['any'] },
            },
            to_if_held_down: [
                {
                    set_variable: {
                        name: 'u_flag',
                        value: true,
                    },
                },
            ],
            to_after_key_up: [
                {
                    set_variable: {
                        name: 'u_flag',
                        value: false,
                    },
                    // Cancel the `to_delayed_action`
                    halt: true,
                },
            ],
            to_if_alone: [{ key_code: 'u' }],
            to_delayed_action: {
                to_if_canceled: [{ key_code: 'u' }],
            },
            parameters: {
                'basic.to_delayed_action_delay_milliseconds': 250,
                'basic.to_if_alone_timeout_milliseconds': 250,
                'basic.to_if_held_down_threshold_milliseconds': 250,
            },
        },
    ]

    definitions.forEach(function (def) {
        manipulators.push({
            type: 'basic',
            from: { key_code: def.from },
            conditions: [{ name: 'u_flag', type: 'variable_if', value: true }],
            to: [
                {
                    software_function: {
                        open_application: {
                            bundle_identifier: def.to,
                        },
                    },
                },
            ],
        })
    })

    return {
        description: 'Switch to the app launcher when the u key is held down',
        manipulators: manipulators,
    }
}

main()

JSON version

💡 How to use this example

{
    "description": "Switch to the app launcher when the u key is held down",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "u",
                "modifiers": { "optional": ["any"] }
            },
            "to_if_held_down": [
                {
                    "set_variable": {
                        "name": "u_flag",
                        "value": true
                    }
                }
            ],
            "to_after_key_up": [
                {
                    "set_variable": {
                        "name": "u_flag",
                        "value": false
                    },
                    // Cancel the `to_delayed_action`
                    "halt": true
                }
            ],
            "to_if_alone": [{ "key_code": "u" }],
            "to_delayed_action": {
                "to_if_canceled": [{ "key_code": "u" }]
            },
            "parameters": {
                "basic.to_delayed_action_delay_milliseconds": 250,
                "basic.to_if_alone_timeout_milliseconds": 250,
                "basic.to_if_held_down_threshold_milliseconds": 250
            }
        },

        //
        // Open Safari
        //

        {
            "type": "basic",
            "from": { "key_code": "s" },
            "conditions": [
                { "name": "u_flag", "type": "variable_if", "value": true }
            ],
            "to": [
                {
                    "software_function": {
                        "open_application": {
                            "bundle_identifier": "com.apple.Safari"
                        }
                    }
                }
            ]
        },

        //
        // Open Terminal
        //

        {
            "type": "basic",
            "from": { "key_code": "t" },
            "conditions": [
                { "name": "u_flag", "type": "variable_if", "value": true }
            ],
            "to": [
                {
                    "software_function": {
                        "open_application": {
                            "bundle_identifier": "com.apple.Terminal"
                        }
                    }
                }
            ]
        }
    ]
}

MultitouchExtension integration

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-MultitouchExtension allows you to change keys only when the finger is on the trackpad.

You can use variable_if or variable_unless to determine either the finger is on trackpad.

Example

The following json changes k key to up_arrow when the finger is on the trackpad.

{
    "type": "basic",
    "from": {
        "key_code": "k",
        "modifiers": {
            "optional": ["any"]
        }
    },
    "to": [
        {
            "key_code": "up_arrow"
        }
    ],
    "conditions": [
        {
            "type": "variable_unless",
            "name": "multitouch_extension_finger_count_total",
            "value": 0
        }
    ]
}

Variables

Karabiner-MultitouchExtension changes the following variables when the finger count on the trackpad is changed.

Quit

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements keeps running in the background even if you close the settings window.
To quit Karabiner-Elements, choose “Quit Karabiner-Elements” from menu bar.

Note

If you’ve hidden the menu bar icon, you can also quit Karabiner-Elements from Settings.

Advanced topic

If you want to terminate Karabiner-Elements from the command line, execute the following commands:

'/Library/Application Support/org.pqrs/Karabiner-Elements/Karabiner-Elements Non-Privileged Agents v2.app/Contents/MacOS/Karabiner-Elements Non-Privileged Agents v2' unregister-core-agents
'/Library/Application Support/org.pqrs/Karabiner-Elements/Karabiner-Elements Non-Privileged Agents v2.app/Contents/MacOS/Karabiner-Elements Non-Privileged Agents v2' unregister-menu-agent
'/Library/Application Support/org.pqrs/Karabiner-Elements/Karabiner-Elements Non-Privileged Agents v2.app/Contents/MacOS/Karabiner-Elements Non-Privileged Agents v2' unregister-multitouch-extension-agent
'/Library/Application Support/org.pqrs/Karabiner-Elements/Karabiner-Elements Non-Privileged Agents v2.app/Contents/MacOS/Karabiner-Elements Non-Privileged Agents v2' unregister-notification-window-agent

to.shell_command

Mon, 01 Jan 0001 00:00:00 +0000

shell_command executes the shell command.

Examples

Open application

💡 How to use this example

{
    "description": "Open Safari by right_command+s",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "s",
                "modifiers": {
                    "mandatory": ["right_command"],
                    "optional": ["caps_lock"]
                }
            },
            "to": [{ "shell_command": "open -a 'Safari.app'" }]
        }
    ]
}

Execute shell from file

💡 How to use this example

{
    "description": "Execute hello.sh by right_command+s",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "s",
                "modifiers": {
                    "mandatory": ["right_command"],
                    "optional": ["caps_lock"]
                }
            },
            "to": [{ "shell_command": "/bin/sh ~/opt/shell_commands/hello.sh" }]
        }
    ]
}

Advanced topic

The very limited environment variables are passed to the command, $HOME, $UID, $USER, etc.

"Fumihiko Takayama" is shown in Login Items

Mon, 01 Jan 0001 00:00:00 +0000

In Allow in the Background of Login Items, Fumihiko Takayama may appear instead of Karabiner-Elements.

There are several causes, but the problem is mainly on the macOS side and is difficult to resolve. (Restarting macOS may solve this issue)

In any case, there is no problem with leaving it as it is.

Expected:

Information for those who want to know more

The confirmed causes are as follows:

Restart

Mon, 01 Jan 0001 00:00:00 +0000

You can restart Karabiner-Elements from the menu bar or Settings.

Advanced topic

If you want to restart Karabiner-Elements from the command line, execute the following command:

launchctl kickstart -k gui/$(id -u)/org.pqrs.service.agent.karabiner_console_user_server

How to use sticky modifier keys

Mon, 01 Jan 0001 00:00:00 +0000

You can enable the sticky modifier keys from Karabiner-Elements Settings > Simple modifications.

Note

The sticky modifier keys acts as general modifier key while you are pressing and holding down the key.

For example, the following operation result is AA instead of Aa.

Press sticky left shift key
Press a key
Release a key
Press a key
Release a key
Release sticky left shift key

If you want to disable this feature, use sticky modifier key (pressing and holding down is disabled).

device_if, device_unless, device_exists_if, device_exists_unless

Mon, 01 Jan 0001 00:00:00 +0000

Change an event if/unless the event is from specified device.

Example

Change caps_lock to escape on Apple keyboards, wiht the vendor ID is 1452 (0x05ac) or 76 (0x004c) or if it’s a built-in keyboard.

💡 How to use this example

{
    "description": "Change caps_lock to escape on Apple keyboards",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "caps_lock",
                "modifiers": { "optional": ["any"] }
            },
            "to": [{ "key_code": "escape" }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [
                        { "vendor_id": 1452 },
                        { "vendor_id": 76 },
                        { "is_built_in_keyboard": true }
                    ]
                }
            ]
        }
    ]
}

Specification

{
    "type": "device_if",
    "identifiers": [
        {
            "vendor_id": 1111,
            "product_id": 2222,
            "description": "my keyboard 1"
        },
        {
            "vendor_id": 3333,
            "product_id": 4444,
            "description": "my keyboard 2"
        },
        ...
    ]
}

Name	Required	Description
`type`	Required	`"device_if"` or `"device_unless"` or `"device_exists_if"` or `"device_exists_unless"`
`identifiers`	Required	Target device definitions
`description`	Optional	A human-readable comment

`type`

Type	Description	Available since
`device_if`	Valid only for devices specified in identifiers	Karabiner-Elements 11.0.0
`device_unless`	Valid only for devices other than specified in identifiers	Karabiner-Elements 11.0.0
`device_exists_if`	Valid if a specified device is connected	Karabiner-Elements 14.8.4
`device_exists_unless`	Valid unless a specified device is connected	Karabiner-Elements 14.8.4

`identifiers`

identifiers is an array of objects.

Features

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements is a powerful and stable keyboard customizer for macOS.

Core features

Simple Modifications: Change normal keys to other keys.
Complex Modifications: Change keys by complex rules.
- Change a key to combination of modifiers. (e.g. change capslock to control+command)
- Change modifiers+key to key. (e.g. change control+m to return)
- Send key events if a key is pressed alone.
- Send key events if keys are pressed simultaneously.
- Mouse keys.
- etc.
Function Keys: Change f1-f12 keys to media controls.
Devices: Apply modifications to specified keyboards only.
Profiles: Support multiple profiles.
Modifier Flag Sync: Synchronize modifier flags across all connected keyboards.
Secure Keyboard Entry Support: Work well on Secure Keyboard Entry environment such as a password prompt, terminal with Secure Keyboard Entry, etc.
Extra Key Support: Enable extra keys on PC keyboard that are not recognized by default in macOS.
- Home key on iPad keyboards such as Logitech K480
- International keys
- Language keys (e.g., 無変換,変換, カタカナ keys on JIS PC keyboard)
- Application Launch Keys

Modification examples

Typical complex_modifications examples

Expert complex_modifications examples

Current limitations

Karabiner-Elements cannot modify the eject key on some keyboard (e.g., Apple Wired Keyboard) due to the limitation of macOS API.
Karabiner-Elements cannot modify the fn key on non-Apple keyboards such as Logitech keyboards.

from.modifiers

Mon, 01 Jan 0001 00:00:00 +0000

from.modifiers is a object which has the following keys.

Key	Value	Required	Description
`mandatory`	An array of strings	Optional	Modifiers which must be pressed
`optional`	An array of strings	Optional	Modifiers which can be pressed

`from.modifiers.mandatory`

Events are manipulated only if mandatory modifiers are pressed.
Mandatory modifiers are removed from to events.

`from.modifiers.optional`

Events are also manipulated even if optional modifiers are pressed.
Optional modifiers are kept in to events.

Tip

If you do not include any in modifiers.optional, your manipulator does not change event if extra modifiers (modifiers which are not included in modifiers.mandatory) are pressed.

How to disable caps lock delay

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements disables the caps lock delay without any action since v13.3.0.

Disable the accidental keystroke prevention of Caps Lock

If you want to disable the behavior where a brief press of the Caps Lock key is ignored (the accidental keystroke prevention feature), please import and enable this Complex Modifications setting.

https://ke-complex-modifications.pqrs.org/#disable_accidental_keystroke_prevention_of_caps_lock

Implicit behavior

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements modifies following behavior automatically without any configurations:

When you are using multiple keyboards, modifier keys are shared with all keyboards.

For example, pressing “shift key on keyboard1” and “space key on keyboard2” sends shift-space.

Apply special handling to specific keys

The application launch keys is ignored when passed directly to macOS, so it will be configured to launch applications within Karabiner-Elements.

iokit_power_management_sleep_system

Mon, 01 Jan 0001 00:00:00 +0000

Put the system to sleep.

iokit_power_management_sleep_system is available since Karabiner-Elements 13.7.1.

Examples

Put the system to sleep using fn+z.

💡 How to use this example

{
    "description": "Put the system to sleep using fn+z",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "z",
                "modifiers": {
                    "mandatory": ["fn"],
                    "optional": ["caps_lock"]
                }
            },
            "to": [
                {
                    "software_function": {
                        "iokit_power_management_sleep_system": {
                            "delay_milliseconds": 500
                        }
                    }
                }
            ]
        }
    ]
}

Specification

{
    "to": [
        {
            "software_function": {
                "iokit_power_management_sleep_system": {
                    "delay_milliseconds": 500
                }
            }
        }
    ]
}

Name	Required	Description
`delay_milliseconds`	Optional	Waiting time before the system goes to sleep (500 ms if unspecified)

Karabiner-Elements stopped working after macOS update

Mon, 01 Jan 0001 00:00:00 +0000

It’s an issue of macOS that macOS update sometimes does not restore the running process state sufficiently after macOS update.

Please follow the instruction to solve the problem.

Restart macOS once again after macOS update.
Reinstall Karabiner-Elements if restart macOS does not solve the problem.

Letter key release order modifier

Mon, 01 Jan 0001 00:00:00 +0000

Holding down v and pressing j or k enters arrow mode.

v (hold) + j: down arrow
v (hold) + k: up arrow

Note

You need to keep holding down the v and j or k keys, or release the j or k key to enter arrow mode.
If you release the v key first, vj or vk will be typed as normal characters.

JavaScript version

💡 How to use this example

// JavaScript must be written in ECMAScript 5.1.

function main() {
    const definitions = [
        { from: 'j', to: 'down_arrow' },
        { from: 'k', to: 'up_arrow' },
    ]

    const manipulators = []

    definitions.forEach(function (def) {
        manipulators.push({
            type: 'basic',
            from: {
                key_code: def.from,
                modifiers: { optional: ['any'] },
            },
            to: [{ key_code: def.to }],
            conditions: [{ type: 'variable_if', name: 'v_flag', value: true }],
        })

        manipulators.push({
            type: 'basic',
            from: {
                simultaneous: [{ key_code: 'v' }, { key_code: def.from }],
                simultaneous_options: {
                    key_down_order: 'strict',
                    key_up_order: 'strict_inverse',
                    to_after_key_up: [
                        { set_variable: { name: 'v_flag', value: false } },
                    ],
                },
                modifiers: { optional: ['any'] },
            },
            to: [
                { set_variable: { name: 'v_flag', value: true } },
                { key_code: def.to },
            ],
            parameters: {
                'basic.simultaneous_threshold_milliseconds': 500,
            },
        })
    })

    return {
        description: 'Holding down v and pressing j,k enters arrow mode',
        manipulators: manipulators,
    }
}

main()

JSON version

💡 How to use this example

{
    "description": "Holding down v and pressing j,k enters arrow mode",
    "manipulators": [
        //
        // v+j
        //

        {
            "type": "basic",
            "from": {
                "key_code": "j",
                "modifiers": { "optional": ["any"] }
            },
            "to": [{ "key_code": "down_arrow" }],
            "conditions": [
                { "type": "variable_if", "name": "v_flag", "value": true }
            ]
        },
        {
            "type": "basic",
            "from": {
                "simultaneous": [{ "key_code": "v" }, { "key_code": "j" }],
                "simultaneous_options": {
                    "key_down_order": "strict",
                    "key_up_order": "strict_inverse",
                    "to_after_key_up": [
                        { "set_variable": { "name": "v_flag", "value": false } }
                    ]
                },
                "modifiers": { "optional": ["any"] }
            },
            "to": [
                { "set_variable": { "name": "v_flag", "value": true } },
                { "key_code": "down_arrow" }
            ],
            "parameters": {
                "basic.simultaneous_threshold_milliseconds": 500
            }
        },

        //
        // v+k
        //

        {
            "type": "basic",
            "from": {
                "key_code": "k",
                "modifiers": { "optional": ["any"] }
            },
            "to": [{ "key_code": "up_arrow" }],
            "conditions": [
                { "type": "variable_if", "name": "v_flag", "value": true }
            ]
        },
        {
            "type": "basic",
            "from": {
                "simultaneous": [{ "key_code": "v" }, { "key_code": "k" }],
                "simultaneous_options": {
                    "key_down_order": "strict",
                    "key_up_order": "strict_inverse",
                    "to_after_key_up": [
                        { "set_variable": { "name": "v_flag", "value": false } }
                    ]
                },
                "modifiers": { "optional": ["any"] }
            },
            "to": [
                { "set_variable": { "name": "v_flag", "value": true } },
                { "key_code": "up_arrow" }
            ],
            "parameters": {
                "basic.simultaneous_threshold_milliseconds": 500
            }
        }
    ]
}

Security

Mon, 01 Jan 0001 00:00:00 +0000

Security is one of the most important aspects of the Karabiner-Elements architecture. Karabiner-Elements separates responsibilities across multiple processes and runs each process with appropriate privileges to reduce the risk of input event leakage.

Processes

Karabiner-Elements restricts input event handling to the Karabiner-Core-Service daemon and Karabiner-VirtualHIDDevice-Daemon processes. These processes run with root privileges, so other processes, including malicious applications, cannot steal input events through Karabiner-Elements.

Process list

Running with root privileges:

to.select_input_source

Mon, 01 Jan 0001 00:00:00 +0000

select_input_source change the current input source.

Caution

Switching to input sources which have input_mode_id (Chinese, Japanese, Korean, Vietnamese) may be failed due to an macOS issue.

For CJKV input sources, sending the input source switch shortcut (e.g., control-space) is better than using select_input_source.

Example

Switch the current input source by:

right_command+e: English
right_command+f: French

💡 How to use this example

{
    "description": "Switch languages by right_command+e (English), right_command+f (French)",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "e",
                "modifiers": {
                    "mandatory": ["right_command"],
                    "optional": ["caps_lock"]
                }
            },
            "to": [{ "select_input_source": { "language": "^en$" } }]
        },
        {
            "type": "basic",
            "from": {
                "key_code": "f",
                "modifiers": {
                    "mandatory": ["right_command"],
                    "optional": ["caps_lock"]
                }
            },
            "to": [{ "select_input_source": { "language": "^fr$" } }]
        }
    ]
}

Specification

{
    "to": [
        {
            "select_input_source": {
                "language": "language regex",
                "input_source_id": "input source id regex",
                "input_mode_id": "input mode id regex"
            }
        }
    ]
}

Name	Required	Description
`language`	Optional	The language regex such as `"^en$"`, `"^fr$"`
`input_source_id`	Optional	The input source id regex such as `"^com\\.apple\\.keylayout\\.US$"`
`input_mode_id`	Optional	The input mode id regex such as `"^com\\.apple\\.inputmethod\\.Japanese\\.Hiragana$"`

Investigate the input source identifiers

You can find the current input source identifiers by EventViewer > Variables tab.

Typical complex_modifications examples

Mon, 01 Jan 0001 00:00:00 +0000

Swap `;` and `:`

Equal to swap ; and shift-;: from.modifiers

💡 How to use this example

{
    "description": "Swap ; and :",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "semicolon",
                "modifiers": {
                    "mandatory": ["shift"],
                    "optional": ["caps_lock"]
                }
            },
            "to": [{ "key_code": "semicolon" }]
        },
        {
            "type": "basic",
            "from": {
                "key_code": "semicolon",
                "modifiers": {
                    "optional": ["caps_lock"]
                }
            },
            "to": [{ "key_code": "semicolon", "modifiers": ["left_shift"] }]
        }
    ]
}

Change `control-h` to `delete`

Change control-h to delete: from.modifiers
Change control-option-h to option-delete.

💡 How to use this example

{
    "description": "Change control-h to delete",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "h",
                "modifiers": {
                    "mandatory": ["control"],
                    "optional": ["caps_lock", "option"]
                }
            },
            "to": [{ "key_code": "delete_or_backspace" }]
        }
    ]
}

Change mouse button4 and button5 to back and forward

Change mouse button 4 and button 5 to [ + left_arrow and ] + right_arrow.

Uninstall

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements provides built-in uninstaller.
Use the uninstaller to remove Karabiner-Elements from your system.

You can launch the uninstaller from “Launch uninstaller” button on Uninstall tab.

Then, follow the instruction of the dialog. (The uninstaller ask your administrator password in order to remove files.)

Uninstall from command line

If you don’t want to use above GUI, you can also uninstall Karabiner-Elements from command line.

bash '/Library/Application Support/org.pqrs/Karabiner-DriverKit-VirtualHIDDevice/scripts/uninstall/deactivate_driver.sh'
sudo '/Library/Application Support/org.pqrs/Karabiner-Elements/uninstall.sh'

(Administrator password is required to run the above command.)

Use more complex modifications

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements provides more complex event modifications.
These rules change keys by conditions.

Examples

Modifier flags + key to keys:
- Change control-m to return key.
- Change control-h to delete key.
Key to modifier flags + keys:
- Change caps lock to command+control+option+shift key
Post other key events when a key pressed alone:
- Post escape key when you press left control key alone.
Change keys in specific apps:
- Change left command key to left control key in virtual machines.
Execute shell command:
- Open Activity Monitor by right shift+a.

There are two ways to add rules

Virtual modifier

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements does not provide virtual modifiers, however you can make your own flag similar to virtual modifier using variables.

Example

The following json change keypad_1 to virtual modifier.

Change keypad_1 to virtual modifier (my_modifier_1).
Change keypad_1 + a to mission_control.
Change keypad_1 + s to launchpad.

[
    {
        "type": "basic",
        "from": {
            "key_code": "keypad_1",
            "modifiers": {
                "mandatory": [],
                "optional": ["any"]
            }
        },
        "to": [
            {
                "set_variable": {
                    "name": "my_modifier_1",
                    "value": 1
                }
            }
        ],
        "to_after_key_up": [
            {
                "set_variable": {
                    "name": "my_modifier_1",
                    "value": 0
                }
            }
        ]
    },

    {
        "type": "basic",
        "from": {
            "key_code": "a",
            "modifiers": {
                "mandatory": [],
                "optional": ["any"]
            }
        },
        "to": [
            {
                "key_code": "mission_control"
            }
        ],
        "conditions": [
            {
                "type": "variable_if",
                "name": "my_modifier_1",
                "value": 1
            }
        ]
    },

    {
        "type": "basic",
        "from": {
            "key_code": "s",
            "modifiers": {
                "mandatory": [],
                "optional": ["any"]
            }
        },
        "to": [
            {
                "key_code": "launchpad"
            }
        ],
        "conditions": [
            {
                "type": "variable_if",
                "name": "my_modifier_1",
                "value": 1
            }
        ]
    }
]

Set environment variables

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements references several environment variables internally. Additionally, the shell_command and open_application used in Complex Modifications are also affected by environment variables. To support this, we provide a way to define them.

Karabiner-Elements loads environment variables from /Library/Application Support/org.pqrs/config/karabiner_environment if the file exists. If you define PATH and others there, shell commands and opened apps via shell_command and open_application inherit these environment variables.

Example

You need to run your editor with root privileges to edit the karabiner_environment file. For example, you can edit it by running the following commands in Terminal.

Add your own complex modifications

Mon, 01 Jan 0001 00:00:00 +0000

Step 1

Open Complex Modifications tab and press Add your own rule button.

Step 2

An editor will open with sample rules. Change the content and press the Save button to register.

Tip

You can save by using the command + s shortcut as well.

When making changes, Karabiner-EventViewer and Karabiner Configuration Reference Manual can be used to confirm the key names and how to write rules.

Guide for supporting unsupported keys

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements supports most keys, including those found only on PC keyboards. However, it may not support certain special function keys, such as some keys in the Consumer Page’s Generic GUI Application Controls. Karabiner-Elements maintains a whitelist of verified keys, and unverified events that are not included in this list are ignored.

This guide explains how to add support for unsupported keys in Karabiner-Elements.

Investigate the key code

Use Karabiner-EventViewer to inspect key codes. First, enable “Temporarily turns off all Karabiner-Elements modifications” in Karabiner-EventViewer so that raw hardware input events are shown.

Edit complex modifications

Mon, 01 Jan 0001 00:00:00 +0000

Open Complex Modifications tab and press Edit button. The editor will open. Change the contents and save it.

Tip

You can save by using the command + s shortcut as well.

When making changes, Karabiner-EventViewer and Karabiner Configuration Reference Manual can be used to confirm the key names and how to write rules.

Add your own complex modifications (using JavaScript)

Mon, 01 Jan 0001 00:00:00 +0000

Step 1

Open Complex Modifications tab and press Add your own rule using JavaScript button.

Step 2

An editor will open with sample rules. Change the content and press the Save button to register.

Tip

You can save by using the command + s shortcut as well.

In JavaScript, you write code that returns the JSON defining the rules.

from.integer_value

Mon, 01 Jan 0001 00:00:00 +0000

from.integer_value is rarely needed. Only a handful of devices require you to distinguish buttons by integer_value, and that’s when you use it.

One such device is the VEC USB Footpedal INFINITY USB-3. It has three buttons, each of which sends the following events:

Hardware Button	event	integer_value
Left Button	`"pointing_button": "button75"`	`"integer_value": 1`
Middle Button	`"pointing_button": "button75"`	`"integer_value": 2`
Right Button	`"pointing_button": "button75"`	`"integer_value": 4`

Limitation

If you press the Middle Button while holding the Left Button, the integer_value becomes 3. However, patterns where integer_value changes mid-press are not supported. The value is interpreted from the first button that was pressed, so in this case it evaluates as integer_value 1.

Check for updates

Mon, 01 Jan 0001 00:00:00 +0000

You can check for updates from Update tab.

Using the latest beta version

Karabiner-Elements also offers beta builds so you can try in-progress features early. These builds do not check for updates automatically, but if you’re interested you can look for and install updates manually using the “Check for beta updates” button.

They’re generally stable enough for everyday use and rarely cause issues. However, new features under development may still change before they ship in a release build, so please keep that in mind when using new features.

Choose devices

Mon, 01 Jan 0001 00:00:00 +0000

Choose devices which Karabiner-Elements modifies events on Devices tab.

Tip

Mice are disabled by default.
You have to enable them if you want to change the mouse buttons in Karabiner-Elements.

complex_modifications manipulator evaluation priority

Mon, 01 Jan 0001 00:00:00 +0000

The manipulators are evaluated from the top to the bottom and the input event is manipulated only the first matched manipulator.

In other words, if there are multiple manipulators which change the same key, the manipulator placed at the top is applied and other manipulators are ignored.

Simple Modifications and Complex Modifications

Simple Modifications and Complex Modifications are independent.

Thus, Simple Modifications does not affect above priority.
Karabiner-Elements changes keys by Simple Modifications, and then changes them by Complex Modifications.

from.simultaneous

Mon, 01 Jan 0001 00:00:00 +0000

simultaneous manipulates keys which are pressed simultaneously in 50 milliseconds.

Example

This json defines manipulator which changes a+s+d to mission_control.

💡 How to use this example

{
    "description": "Pressing the a,s,d keys simultaneously launches Mission Control",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "simultaneous": [
                    { "key_code": "a" },
                    { "key_code": "s" },
                    { "key_code": "d" }
                ],
                "modifiers": { "optional": ["any"] }
            },
            "to": [{ "apple_vendor_keyboard_key_code": "mission_control" }]
        }
    ]
}

Note

There are some cases simultaneous does not modify events.

Input event modification chaining

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements treats input events by the following order:

Catch events from hardware.
Apply Simple Modifications.
Apply Complex Modifications.
Apply Function Keys Modifications. (change f1…f12 keys to media controls)
Apply System Settings > Keyboard > Keyboard Shortcuts… > Modifier Keys.
Post events to applications via a virtual keyboard.

Is it possible to adjust the key repeat rate?

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements does not provide a feature to adjust key repeat rate.

Use System Settings > Keyboard.

You can also adjust the key repeat rate using defaults write command. https://apple.stackexchange.com/questions/10467/how-to-increase-keyboard-key-repeat-rate-on-os-x

keyboard_type_if, keyboard_type_unless

Mon, 01 Jan 0001 00:00:00 +0000

Change an event if/unless the event is from specified type keyboard.

The keyboard type mentioned here refers to the type of the virtual keyboard.

Example

Change control-[ key to escape, including JIS layout support.

Note: the [ key is close_bracket in JIS layout

💡 How to use this example

{
    "description": "Change control-[ to escape",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "open_bracket",
                "modifiers": {
                    "mandatory": ["control"],
                    "optional": ["caps_lock"]
                }
            },
            "to": [{ "key_code": "escape" }],
            "conditions": [
                {
                    "keyboard_types": ["ansi", "iso"],
                    "type": "keyboard_type_if"
                }
            ]
        },
        {
            "type": "basic",
            "from": {
                "key_code": "close_bracket",
                "modifiers": {
                    "mandatory": ["control"],
                    "optional": ["caps_lock"]
                }
            },
            "to": [{ "key_code": "escape" }],
            "conditions": [
                {
                    "keyboard_types": ["jis"],
                    "type": "keyboard_type_if"
                }
            ]
        }
    ]
}

Specification

{
    "type": "keyboard_type_if",
    "keyboard_types": ["ansi", "iso"]
}

Name	Required	Description
`type`	Required	`"keyboard_type_if"` or `"keyboard_type_unless"`
`keyboard_types`	Required	An array of `"ansi"`, `"iso"` or `"jis"`
`description`	Optional	A human-readable comment

Multiple keyboard types

keyboard_types are joined by “or”.

open_application

Mon, 01 Jan 0001 00:00:00 +0000

Open an application, or if it’s already running, bring it into focus.

Examples

Open EventViewer by right command + v:

💡 How to use this example

{
    "description": "Open EventViewer by right command + v",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "v",
                "modifiers": {
                    "mandatory": ["right_command"],
                    "optional": ["caps_lock"]
                }
            },
            "to": [
                {
                    "software_function": {
                        "open_application": {
                            "file_path": "/Applications/Karabiner-EventViewer.app"
                        }
                    }
                }
            ]
        }
    ]
}

Focus recently opened applications by right command + 1, right command + 2, right command + 3:

Swap fn and non-fn behavior for function keys on external keyboards

Mon, 01 Jan 0001 00:00:00 +0000

Use f3 as Mission Control on the built-in keyboard, and fn+f3 as Mission Control on external keyboards.

JavaScript version

💡 How to use this example

// JavaScript must be written in ECMAScript 5.1.

function main() {
    const manipulators = []

    for (var i = 1; i <= 12; ++i) {
        const fkey = 'f' + i

        manipulators.push({
            type: 'basic',
            from: {
                key_code: fkey,
                modifiers: { mandatory: ['fn'], optional: ['any'] },
            },
            to: [{ key_code: fkey }],
            conditions: [
                {
                    type: 'device_if',
                    identifiers: [{ is_built_in_keyboard: false }],
                },
            ],
        })

        manipulators.push({
            type: 'basic',
            from: { key_code: fkey, modifiers: { optional: ['any'] } },
            to: [{ key_code: fkey, modifiers: ['fn'] }],
            conditions: [
                {
                    type: 'device_if',
                    identifiers: [{ is_built_in_keyboard: false }],
                },
            ],
        })
    }

    return {
        description:
            'Swap fn and non-fn behavior for function keys on external keyboards',
        manipulators: manipulators,
    }
}

main()

JSON version

💡 How to use this example

{
    "description": "Swap fn and non-fn behavior for function keys on external keyboards",
    "manipulators": [
        //
        // f1
        //

        {
            "type": "basic",
            "from": {
                "key_code": "f1",
                "modifiers": { "mandatory": ["fn"], "optional": ["any"] }
            },
            "to": [{ "key_code": "f1" }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },
        {
            "type": "basic",
            "from": { "key_code": "f1", "modifiers": { "optional": ["any"] } },
            "to": [{ "key_code": "f1", "modifiers": ["fn"] }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },

        //
        // f2
        //

        {
            "type": "basic",
            "from": {
                "key_code": "f2",
                "modifiers": { "mandatory": ["fn"], "optional": ["any"] }
            },
            "to": [{ "key_code": "f2" }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },
        {
            "type": "basic",
            "from": { "key_code": "f2", "modifiers": { "optional": ["any"] } },
            "to": [{ "key_code": "f2", "modifiers": ["fn"] }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },

        //
        // f3
        //

        {
            "type": "basic",
            "from": {
                "key_code": "f3",
                "modifiers": { "mandatory": ["fn"], "optional": ["any"] }
            },
            "to": [{ "key_code": "f3" }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },
        {
            "type": "basic",
            "from": { "key_code": "f3", "modifiers": { "optional": ["any"] } },
            "to": [{ "key_code": "f3", "modifiers": ["fn"] }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },

        //
        // f4
        //

        {
            "type": "basic",
            "from": {
                "key_code": "f4",
                "modifiers": { "mandatory": ["fn"], "optional": ["any"] }
            },
            "to": [{ "key_code": "f4" }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },
        {
            "type": "basic",
            "from": { "key_code": "f4", "modifiers": { "optional": ["any"] } },
            "to": [{ "key_code": "f4", "modifiers": ["fn"] }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },

        //
        // f5
        //

        {
            "type": "basic",
            "from": {
                "key_code": "f5",
                "modifiers": { "mandatory": ["fn"], "optional": ["any"] }
            },
            "to": [{ "key_code": "f5" }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },
        {
            "type": "basic",
            "from": { "key_code": "f5", "modifiers": { "optional": ["any"] } },
            "to": [{ "key_code": "f5", "modifiers": ["fn"] }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },

        //
        // f6
        //

        {
            "type": "basic",
            "from": {
                "key_code": "f6",
                "modifiers": { "mandatory": ["fn"], "optional": ["any"] }
            },
            "to": [{ "key_code": "f6" }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },
        {
            "type": "basic",
            "from": { "key_code": "f6", "modifiers": { "optional": ["any"] } },
            "to": [{ "key_code": "f6", "modifiers": ["fn"] }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },

        //
        // f7
        //

        {
            "type": "basic",
            "from": {
                "key_code": "f7",
                "modifiers": { "mandatory": ["fn"], "optional": ["any"] }
            },
            "to": [{ "key_code": "f7" }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },
        {
            "type": "basic",
            "from": { "key_code": "f7", "modifiers": { "optional": ["any"] } },
            "to": [{ "key_code": "f7", "modifiers": ["fn"] }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },

        //
        // f8
        //

        {
            "type": "basic",
            "from": {
                "key_code": "f8",
                "modifiers": { "mandatory": ["fn"], "optional": ["any"] }
            },
            "to": [{ "key_code": "f8" }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },
        {
            "type": "basic",
            "from": { "key_code": "f8", "modifiers": { "optional": ["any"] } },
            "to": [{ "key_code": "f8", "modifiers": ["fn"] }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },

        //
        // f9
        //

        {
            "type": "basic",
            "from": {
                "key_code": "f9",
                "modifiers": { "mandatory": ["fn"], "optional": ["any"] }
            },
            "to": [{ "key_code": "f9" }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },
        {
            "type": "basic",
            "from": { "key_code": "f9", "modifiers": { "optional": ["any"] } },
            "to": [{ "key_code": "f9", "modifiers": ["fn"] }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },

        //
        // f10
        //

        {
            "type": "basic",
            "from": {
                "key_code": "f10",
                "modifiers": { "mandatory": ["fn"], "optional": ["any"] }
            },
            "to": [{ "key_code": "f10" }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },
        {
            "type": "basic",
            "from": { "key_code": "f10", "modifiers": { "optional": ["any"] } },
            "to": [{ "key_code": "f10", "modifiers": ["fn"] }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },

        //
        // f11
        //

        {
            "type": "basic",
            "from": {
                "key_code": "f11",
                "modifiers": { "mandatory": ["fn"], "optional": ["any"] }
            },
            "to": [{ "key_code": "f11" }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },
        {
            "type": "basic",
            "from": { "key_code": "f11", "modifiers": { "optional": ["any"] } },
            "to": [{ "key_code": "f11", "modifiers": ["fn"] }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },

        //
        // f12
        //

        {
            "type": "basic",
            "from": {
                "key_code": "f12",
                "modifiers": { "mandatory": ["fn"], "optional": ["any"] }
            },
            "to": [{ "key_code": "f12" }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        },
        {
            "type": "basic",
            "from": { "key_code": "f12", "modifiers": { "optional": ["any"] } },
            "to": [{ "key_code": "f12", "modifiers": ["fn"] }],
            "conditions": [
                {
                    "type": "device_if",
                    "identifiers": [{ "is_built_in_keyboard": false }]
                }
            ]
        }
    ]
}

to.set_variable

Mon, 01 Jan 0001 00:00:00 +0000

set_variable defines and updates the variable value.

Tip

set_variable is designed to use with the following conditions:

Examples

Pressing the a key while holding the escape key launches Activity Monitor.

💡 How to use this example

{
    "description": "Pressing the a key while holding the escape key launches Activity Monitor",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "escape",
                "modifiers": { "optional": ["any"] }
            },
            "to": [
                {
                    "set_variable": {
                        "name": "escape_pressed",
                        "value": true,
                        "key_up_value": false
                    }
                }
            ],
            "to_if_alone": [{ "key_code": "escape" }]
        },
        {
            "type": "basic",
            "from": {
                "key_code": "a",
                "modifiers": { "optional": ["any"] }
            },
            "to": [
                {
                    "software_function": {
                        "open_application": {
                            "bundle_identifier": "com.apple.ActivityMonitor"
                        }
                    }
                }
            ],
            "conditions": [
                {
                    "type": "variable_if",
                    "name": "escape_pressed",
                    "value": true
                }
            ]
        }
    ]
}

Specification

{
    "to": [
        {
            "set_variable": {
                "name": "variable name",
                "value": variable value,
                "expression": expression,
                "key_up_value": variable value,
                "key_up_expression": expression,
                "type": "set"
            }
        }
    ]
}

Name	Required	Description	Available since
`name`	Required	Target variable name.	Karabiner-Elements 11.0.0
`value`	Required \| Optional	Target variable value.	Karabiner-Elements 11.0.0
`expression`	Required \| Optional	Target expression.	Karabiner-Elements 15.5.19
`key_up_value`	Optional	A variable value when key is up	Karabiner-Elements 14.12.6
`key_up_expression`	Optional	An expression when key is up	Karabiner-Elements 15.5.19
`type`	Optional	“set” or “unset”	Karabiner-Elements 14.99.2

Note: If key_up_value or type is specified, the value can be omitted.

Touch Bar does not change to f1-f12 when I press the fn key

Mon, 01 Jan 0001 00:00:00 +0000

It’s an issue of macOS, and unfortunately, Karabiner-Elements cannot avoid this issue.
Instead, please change fn+number keys to function keys in Karabiner-Elements configuration.

Import Map fn + number keys to function keys
Enable Map fn + number keys to their corresponding function keys.
You can use f1-f12 keys by fn+number keys.

Note

If you are using “Use all F1, F2, etc. keys as standard function keys.”, enable Map fn + number keys to their corresponding media control keys instead.

What is the lock indicator on Karabiner-Elements and Karabiner-EventViewer icon

Mon, 01 Jan 0001 00:00:00 +0000

Info

This content is for older versions of Karabiner Elements.

Prior to Karabiner-Elements 14.10.0, a lock indicator is shown on Karabiner-Elements and Karabiner-EventViewer icon.

These indicators show that these files are protected so that they cannot be deleted from Finder.

Why these files are protected

This protection is intended to prevent incomplete uninstallation.

Karabiner-Elements is a system-wide software, and files are installed in appropriate locations besides the Applications folder.

to.set_notification_message

Mon, 01 Jan 0001 00:00:00 +0000

set_notification_message sets or remove the notification message.

Examples

Show the notification message while you press right shift key.

💡 How to use this example

{
    "description": "Show a message while right_shift is pressed",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "right_shift",
                "modifiers": {
                    "optional": ["any"]
                }
            },
            "to": [
                {
                    // Show the notification message
                    "set_notification_message": {
                        "id": "my_message",
                        "text": "Hello World!"
                    }
                },
                {
                    "key_code": "right_shift"
                }
            ],
            "to_after_key_up": [
                {
                    // Hide the notification message
                    "set_notification_message": {
                        "id": "my_message",
                        "text": ""
                    }
                }
            ]
        }
    ]
}

Specification

{
    "to": [
        {
            "set_notification_message": {
                "id": "identifier of the message",
                "text": "message text"
            }
        }
    ]
}

Name	Required	Description
`id`	Required	Specify an unique string for your notification message
`text`	Required	Message body

Important

Do not forget to remove the notification message.

Confirm the result of configuration (EventViewer)

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements provides a built-in event viewer named Karabiner-EventViewer. You can show keyboard and mouse events by using it.

Open Karabiner-EventViewer from Apps or Finder.
Input events will be shown when you type keyboard.

How to check the device’s original events

EventViewer shows events after Karabiner-Elements has modified them. However, when you configure Karabiner-Elements to change an event, you must specify the original event that the device sends. This is why trying to modify the event shown in EventViewer sometimes does not work.

Control-eject shortcut does not work when Karabiner-Elements is running

Mon, 01 Jan 0001 00:00:00 +0000

It’s an issue of macOS, and unfortunately, Karabiner-Elements cannot avoid this issue.
Instead, please change fn+escape to eject and use control+fn+escape (== control+eject) shortcut.

Import Change escape key.
Enable Change fn+escape to eject.
You can use control+fn+escape as control+eject.

Disable the built-in keyboard when external keyboard is connected

Mon, 01 Jan 0001 00:00:00 +0000

You can disable MacBook built-in keyboard if external keyboards are connected.
This feature is useful when you put the external keybaord on top of the built-in keyboard.

Enable Disable the built-in keyboard while this device is connected in Devices tab.

Configure the built-in keyboard detection

Enable Treat as a built-in keyboard in Devices if your built-in keyboard is not recognized properly or you want to add a device that will be disabled,

from.simultaneous_options

Mon, 01 Jan 0001 00:00:00 +0000

simultaneous_options adjust the simultaneous behavior.

Key	Value	Description
`detect_key_down_uninterruptedly`	`true` or `false`	Specify whether key_down detection is interrupted with unrelated events
`key_down_order`	`insensitive`, `strict` or `strict_inverse`	Restriction of key_down order
`key_up_order`	`insensitive`, `strict` or `strict_inverse`	Restriction of key_up order
`key_up_when`	`any` or `all`	When key_up events are posted
`to_after_key_up`	An array of `to` event definitions	Events will be posted when all `from` events are released

`detect_key_down_uninterruptedly`

If detect_key_down_uninterruptedly is true, Karabiner-Elements changes simultaneous events even if unrelated key down event exists between target events.

How to disable running Karabiner-Elements at login

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements will be started automatically at login after once you have run Karabiner-ELements.

Quit Karabiner-Elements if you want to stop running Karabiner-Elements at login.

input_source_if, input_source_unless

Mon, 01 Jan 0001 00:00:00 +0000

Change an event if/unless the current input source is the specified value.

Example

Switching input source between Japanese and English at tapping the left command key.

💡 How to use this example

{
    "description": "Switching input source between Japanese and English at tapping the left command key",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "left_command",
                "modifiers": { "optional": ["any"] }
            },
            "to": [{ "key_code": "left_command", "lazy": true }],
            "to_if_alone": [{ "key_code": "japanese_eisuu" }],
            "to_if_held_down": [{ "key_code": "left_command" }],
            "conditions": [
                {
                    "input_sources": [{ "language": "ja" }],
                    "type": "input_source_if"
                }
            ],
            "parameters": {
                "basic.to_if_held_down_threshold_milliseconds": 100
            }
        },
        {
            "type": "basic",
            "from": {
                "key_code": "left_command",
                "modifiers": { "optional": ["any"] }
            },
            "to": [{ "key_code": "left_command", "lazy": true }],
            "to_if_alone": [{ "key_code": "japanese_kana" }],
            "to_if_held_down": [{ "key_code": "left_command" }],
            "conditions": [
                {
                    "input_sources": [{ "language": "en" }],
                    "type": "input_source_if"
                }
            ],
            "parameters": {
                "basic.to_if_held_down_threshold_milliseconds": 100
            }
        }
    ]
}

Specification

{
    "type": "input_source_if",
    "input_sources": [
        {
            "language": "language regex",
            "input_source_id": "input source id regex",
            "input_mode_id": "input mode id regex"
        },
        {
            "language": "language regex",
            "input_source_id": "input source id regex",
            "input_mode_id": "input mode id regex"
        },
        ...
    ]
}

Name	Required	Description
`type`	Required	`"input_source_if"` or `"input_source_unless"`
`input_sources`	Required	Target input source definitions
`description`	Optional	A human-readable comment

`input_sources`

input_sources is an array of objects.

karabiner.json data structure

Mon, 01 Jan 0001 00:00:00 +0000

Note

You can write comments in JSON using // ... or /* ... */ formats, but all comments will be lost if the settings are modified through the Menu or Settings UI.

karabiner.json

{
    "global": {
        "check_for_updates_on_startup": true,
        "show_in_menu_bar": true,
        "show_profile_name_in_menu_bar": false
    },
    "profiles": [
        {
            "name": "Profile name",
            "selected": true,
            "simple_modifications": [
                ...
            ],
            "fn_function_keys": [
                ...
            ],
            "complex_modifications": {
                "parameters": {
                    ...
                },
                "rules": [
                    ...
                ]
            },
            "virtual_hid_keyboard": {
                "keyboard_type": "ansi",
                "caps_lock_delay_milliseconds": 0
            },
            "devices": [
                ...
            ],
            "parameters": {
                ...
            }
        },
        {
            "name": "Profile name",
            "selected": false,
            ...
        },
        ...
    ]
}

complex_modifications in karabiner.json > profiles

{
    "complex_modifications": {
        "parameters": {
            ...
        },
        "rules": [
            {
                "description": "This description is shown in Settings.",
                "manipulators": [
                    {
                        "type": "basic",

                        "from": from event definition,

                        "to": [
                            to event definition,
                            to event definition,
                            ...
                        ],

                        "to_if_alone": [
                            to event definition,
                            to event definition,
                            ...
                        ],

                        "to_if_held_down": [
                            to event definition,
                            to event definition,
                            ...
                        ],

                        "to_after_key_up": [
                            to event definition,
                            to event definition,
                            ...
                        ],

                        "to_delayed_action": {
                            "to_if_invoked": [
                                to event definition,
                                to event definition,
                                ...
                            ],
                            "to_if_canceled": [
                                to event definition,
                                to event definition,
                                ...
                            ]
                        },

                        "conditions": [
                            condition definition,
                            condition definition,
                            ...
                        ],

                        "parameters": {
                            ...
                        },

                        "description": "Optional description for human"
                    },
                    {
                        "type": "basic",
                        ...
                    },
                    ...
                ]
            },
            {
                "description": "...",
                "manipulators": [
                    ...
                ]
            },
            ...
        ]
    }
}

custom `*.json` file in ~/config/karabiner/assets/complex_modifications

Note

Adding a custom .json file allows for enabling and disabling rules/complex modifications through the UI.

MultitouchExtension

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-MultitouchExtension allows you to change keys only when your finger is on the trackpad.

Note

Karabiner-MultitouchExtension is available since Karabiner-Elements 12.6.9

MultitouchExtension usage

Open MultitouchExtension app from Karabiner-Elements Settings > Misc.
Open Settings from menu.
Adjust the effective area of the trackpad.

Tip

If you hid Karabiner-MultitouchExtension icon in Dock, press “Open MultitouchExtension app” button on Preferences > Misc to open Karabiner-MultitouchExtension Preferences.

set_mouse_cursor_position

Mon, 01 Jan 0001 00:00:00 +0000

Move the mouse cursor to the specified point.

Example

Set the mouse cursor position to center of the first screen by right_shift+c.

💡 How to use this example

{
    "description": "Set the mouse cursor position to center of the first screen by right_shift+c",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "c",
                "modifiers": {
                    "mandatory": ["right_shift"],
                    "optional": ["caps_lock"]
                }
            },
            "to": [
                {
                    "software_function": {
                        "set_mouse_cursor_position": {
                            "x": "50%",
                            "y": "50%",
                            "screen": 0
                        }
                    }
                }
            ]
        }
    ]
}

Specification

{
    "to": [
        {
            "software_function": {
                "set_mouse_cursor_position": {
                    "x": 0,
                    "y": 0,
                    "screen": 0
                }
            }
        }
    ]
}

Name	Required	Description
`x`	Required	The new mouse cursor position
`y`	Required	The new mouse cursor position
`screen`	Optional	The screen index of the new mouse cursor origin

Position format

There are two styles to specify the position.

to.mouse_key

Mon, 01 Jan 0001 00:00:00 +0000

Move mouse pointer and scroll by mouse_key.

Example

	shortcuts
Move mouse cursor	`right_shift + arrow keys`
Fast move	`right_shift + f + arrow keys`
Click	`right_shift + v`
Scroll wheel	`right_command + arrow keys`

💡 How to use this example

{
    "description": "Move mouse cursor by right_shift + arrows, scroll by right_command + arrows",
    "manipulators": [
        // y
        {
            "type": "basic",
            "from": {
                "key_code": "up_arrow",
                "modifiers": { "mandatory": "right_shift", "optional": ["any"] }
            },
            "to": [{ "mouse_key": { "y": -1536 } }]
        },
        {
            "type": "basic",
            "from": {
                "key_code": "down_arrow",
                "modifiers": { "mandatory": "right_shift", "optional": ["any"] }
            },
            "to": [{ "mouse_key": { "y": 1536 } }]
        },

        // x
        {
            "type": "basic",
            "from": {
                "key_code": "left_arrow",
                "modifiers": { "mandatory": "right_shift", "optional": ["any"] }
            },
            "to": [{ "mouse_key": { "x": -1536 } }]
        },
        {
            "type": "basic",
            "from": {
                "key_code": "right_arrow",
                "modifiers": { "mandatory": "right_shift", "optional": ["any"] }
            },
            "to": [{ "mouse_key": { "x": 1536 } }]
        },

        // speed_multiplier
        {
            "type": "basic",
            "from": {
                "key_code": "f",
                "modifiers": { "mandatory": "right_shift", "optional": ["any"] }
            },
            "to": [{ "mouse_key": { "speed_multiplier": 4.0 } }]
        },

        // click
        {
            "type": "basic",
            "from": {
                "key_code": "v",
                "modifiers": { "mandatory": "right_shift", "optional": ["any"] }
            },
            "to": [{ "pointing_button": "button1" }]
        },

        // vertical_wheel
        {
            "type": "basic",
            "from": {
                "key_code": "up_arrow",
                "modifiers": {
                    "mandatory": "right_command",
                    "optional": ["any"]
                }
            },
            "to": [{ "mouse_key": { "vertical_wheel": -32 } }]
        },
        {
            "type": "basic",
            "from": {
                "key_code": "down_arrow",
                "modifiers": {
                    "mandatory": "right_command",
                    "optional": ["any"]
                }
            },
            "to": [{ "mouse_key": { "vertical_wheel": 32 } }]
        },

        // horizontal_wheel
        {
            "type": "basic",
            "from": {
                "key_code": "left_arrow",
                "modifiers": {
                    "mandatory": "right_command",
                    "optional": ["any"]
                }
            },
            "to": [{ "mouse_key": { "horizontal_wheel": 32 } }]
        },
        {
            "type": "basic",
            "from": {
                "key_code": "right_arrow",
                "modifiers": {
                    "mandatory": "right_command",
                    "optional": ["any"]
                }
            },
            "to": [{ "mouse_key": { "horizontal_wheel": -32 } }]
        }
    ]
}

Specification

{
    "to": [
        {
            "mouse_key": {
                "x": speed,
                "y": speed,
                "vertical_wheel": speed,
                "horizontal_wheel": speed,
                "speed_multiplier": 1.0
            }
        }
    ]
}

Name	Required	Description
`x`	Optional	Move left (x < 0) or right (x > 0)
`y`	Optional	Move up (y < 0) or down (y > 0)
`vertical_wheel`	Optional	Scroll up (vertical_wheel < 0) or down (vertical_wheel > 0)
`horizontal_wheel`	Optional	Scroll left (horizontal_wheel > 0) or right (horizontal_wheel < 0)
`speed_multiplier`	Optional	Multiply mouse keys speed while this key is hold down

Note

Speed and scroll direction depend on System Settings > Mouse configuration.

Cannot use some three key combinations (key event is not fired)

Mon, 01 Jan 0001 00:00:00 +0000

It’s a hardware limitation of your keyboard called “two-key rollover” if you cannot use some three key combinations. (e.g., physical left command key + right command key + m)

There are two way to avoid the rollover problem.

Use another keyboard which is N-key rollover.
Use other key combinations.

to.sticky_modifier

Mon, 01 Jan 0001 00:00:00 +0000

sticky_modifier changes a key to a sticky modifier key.

Examples

💡 How to use this example

{
    "description": "Change right_shift to sticky modifier",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "right_shift",
                "modifiers": { "optional": ["any"] }
            },
            "to": [{ "key_code": "right_shift" }],
            "to_if_alone": [{ "sticky_modifier": { "right_shift": "toggle" } }]
        }
    ]
}

Specification

{
    "to": [
        {
            "sticky_modifier": {
                "{modifier_name}": "on | off | toggle"
            }
        }
    ]
}

Name	Required	Description
`{modifier_name}`	Optional	- `on` always activates a sticky modifier. - `off` is vice versa. - `toggle` toggles a sticky modifier. `toggle` is suitable for most cases.

Supported modifiers

left_control
left_shift
left_option
left_command
right_control
right_shift
right_option
right_command
fn

Note

You have to specify only one modifier.

to.send_user_command

Mon, 01 Jan 0001 00:00:00 +0000

send_user_command sends a command to an external program prepared by the user.

This mechanism is designed to let an external program process input with even lower latency than shell_command.

To use send_user_command, you need to prepare an external program separately. There are mainly two approaches.

One approach is to build a Swift program that integrates the Karabiner-Elements-user-command-receiver Swift package.

A sample program built with this approach is Karabiner-Elements-user-command-server. It receives commands such as set_window_frames and show_window_frames and changes window positions.

"karabiner.json is not owned by a valid user" error message in log

Mon, 01 Jan 0001 00:00:00 +0000

If the following error message is appeared in log, your home directory owner ship is not valid.

[warning] [core_service] /Users/.../karabiner.json is not owned by a valid user.

The cause is that you are using an external storage and locating your home directory into the volume.

You have to enable ownership on the external volume by the following command in Terminal.app.

sudo diskutil enableOwnership disk99999s99999

(Replace disk99999s99999 with your disk identifier which you can find by diskutil list command.)

Command line interface

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements provides a command line interface which provides the following functions.

Switch a profile by name.
Show current profile name.
Show all profile names.
Set variables which are used in complex modifications.
Copy the current profile to system default profile. (Administrator privilege is required.)
Remove the system default profile. (Administrator privilege is required.)
Lint complex_modifications.json.
Display version.

Usage

Show help

Run the following command in terminal.

'/Library/Application Support/org.pqrs/Karabiner-Elements/bin/karabiner_cli'

Result:

A command line utility of Karabiner-Elements
Usage:
  karabiner_cli [OPTION...] positional parameters

      --select-profile arg      Select a profile by name
      --show-current-profile-name
                                Show current profile name
      --list-profile-names      Show all profile names
      --list-connected-devices  Show all connected devices
      --list-system-variables   Show all system variables
      --list-multitouch-extension-variables
                                Show all multitouch extension variables
      --watch-multitouch-extension-variables [=polling-interval-in-milliseconds(=500)]
                                Watch multitouch extension variables and
                                print all of them in one line whenever any
                                variable changes
      --set-variables arg       Json string: {[key: string]:
                                number|boolean|string}
      --copy-current-profile-to-system-default-profile
                                Copy the current profile to system default
                                profile
      --remove-system-default-profile
                                Remove the system default profile
      --show-settings-window-guidance
                                Show the settings window guidance state
      --lint-complex-modifications glob-patterns
                                Check complex_modifications.json
      --format-json glob-patterns
                                Format json files
      --eval-js glob-patterns   Run javascript files using Duktape
      --version                 Displays version
      --version-number          Displays version_number
      --help                    Print help
      --silent                  Suppress messages

Examples:
  karabiner_cli --select-profile 'Default profile'
  karabiner_cli --show-current-profile-name
  karabiner_cli --list-profile-names
  karabiner_cli --set-variables '{"cli_flag1":1, "cli_flag2":2}'

Examples

Switch profile

Run the following command in terminal.

How to use Karabiner-Elements on the password entry screen before logging in

Mon, 01 Jan 0001 00:00:00 +0000

To use Karabiner-Elements settings on the password entry screen before login, click Copy the current configuration to the system default configuration in the Misc tab of the Settings screen. The copied configuration will be applied before any user logs in.

This configuration also becomes the default for users who have not set up Karabiner-Elements, such as guest users.

Caution

If multiple people use your Mac, enabling this feature may cause confusion due to unexpected keyboard behavior. Be sure to inform other users before turning it on.

Manage profiles

Mon, 01 Jan 0001 00:00:00 +0000

You can switch profiles from menu bar.

Manage profiles

You can manage profiles from Profiles tab.
Press Add new profile button to add new profile.

Set keyboard type

Mon, 01 Jan 0001 00:00:00 +0000

You can change the keyboard type (ANSI, ISO, JIS) from Virtual Keyboard tab.

Troubleshooting > Input symbols are different from the key code name on non-ANSI keyboards

to.modifiers

Mon, 01 Jan 0001 00:00:00 +0000

to.modifiers is an array of the following strings.

Name	Description
`caps_lock`	—
`left_command`	—
`left_control`	—
`left_option`	—
`left_shift`	—
`right_command`	—
`right_control`	—
`right_option`	—
`right_shift`	—
`fn`	—
`command`	Alias of `left_command`
`control`	Alias of `left_control`
`option`	Alias of `left_option`
`shift`	Alias of `left_shift`
`left_alt`	Alias of `left_option` (available since Karabiner-Elements 12.3.0)
`left_gui`	Alias of `left_command` (available since Karabiner-Elements 12.3.0)
`right_alt`	Alias of `right_option` (available since Karabiner-Elements 12.3.0)
`right_gui`	Alias of `right_command` (available since Karabiner-Elements 12.3.0)

variable_if, variable_unless

Mon, 01 Jan 0001 00:00:00 +0000

Change an event if/unless the variable is the specified value.

Example

Pressing the a key while holding the escape key launches Activity Monitor.

💡 How to use this example

{
    "description": "Pressing the a key while holding the escape key launches Activity Monitor",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "escape",
                "modifiers": { "optional": ["any"] }
            },
            "to": [
                {
                    "set_variable": {
                        "name": "escape_pressed",
                        "value": true,
                        "key_up_value": false
                    }
                }
            ],
            "to_if_alone": [{ "key_code": "escape" }]
        },
        {
            "type": "basic",
            "from": {
                "key_code": "a",
                "modifiers": { "optional": ["any"] }
            },
            "to": [
                {
                    "software_function": {
                        "open_application": {
                            "bundle_identifier": "com.apple.ActivityMonitor"
                        }
                    }
                }
            ],
            "conditions": [
                {
                    "type": "variable_if",
                    "name": "escape_pressed",
                    "value": true
                }
            ]
        }
    ]
}

Specification

Tip

variable_if and variable_unless are designed to be used with the following features:

expression_if, expression_unless

Mon, 01 Jan 0001 00:00:00 +0000

Change an event when the evaluated result of the expression is true/false.

Example

Send Command+Q only when it has been pressed twice.

💡 How to use this example

{
    "description": "Prevent unintended Command+Q presses by ignoring it unless it's double-pressed",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "q",
                "modifiers": {
                    "mandatory": ["command"],
                    "optional": ["any"]
                }
            },
            "to": [
                {
                    "key_code": "q",
                    "modifiers": ["command"]
                }
            ],
            "conditions": [
                {
                    "type": "expression_if",
                    "expression": "command_q_expiration > system.now.milliseconds"
                }
            ]
        },
        {
            "type": "basic",
            "from": {
                "key_code": "q",
                "modifiers": {
                    "mandatory": ["command"],
                    "optional": ["any"]
                }
            },
            "to": [
                {
                    "set_variable": {
                        "name": "command_q_expiration",
                        "expression": "system.now.milliseconds + 300"
                    }
                }
            ]
        }
    ]
}

Specification

Tip

expression_if and expression_unless are designed to be used with the following features:

to.from_event

Mon, 01 Jan 0001 00:00:00 +0000

Specifying to.from_event lets you send the key defined in from as-is. With this, using a rule like the one below, you can disable changes from other Complex Modifications when you enable pass-through mode with fn+p.

This uses the property that in Complex Modifications, once an event is modified, it is no longer subject to subsequent rules. In other words, by handling events early with from.any and to.from_event, later rules are effectively disabled.

Configure icon in menu bar

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements shows an icon in menu bar which provides the following functions:

Switch profiles.
Open Settings.
Check for updates.
Open EventViewer.
Restart & Quit Karabiner-Elements.

If you want to hide it, turn off “Show icon in menu bar” on Settings > Misc tab.

Details on changing to function keys

Mon, 01 Jan 0001 00:00:00 +0000

To send F1-F12 function keys to an application using Karabiner-Elements, there is a bit of a trick. This is because if you simply send an F1 key using Simple Modifications or Complex Modifications, it will be interpreted as media controls (e.g., display_brightness_decrement) by subsequent Function Keys Modifications or the macOS driver.

Therefore, if you want to send F1-F12 keys to an application, you need to send fn+F1-F12 instead.

For example, the following Complex Modifications sends fn+F2 (cell editing) to Excel with command+e.

event_changed_if, event_changed_unless

Mon, 01 Jan 0001 00:00:00 +0000

Change an event if/unless the event is already changed by other manipulators.

Example

Change tab key to return_or_enter if the tab key is the physical tab key. (If the tab key is the result of modifying another key by simple modification, the key is ignored.)

💡 How to use this example

{
    "description": "Change tab key to return_or_enter if the tab key is the physical tab key",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "tab",
                "modifiers": { "optional": ["any"] }
            },
            "to": [{ "key_code": "return_or_enter" }],
            "conditions": [
                {
                    "type": "event_changed_if",
                    "value": false
                }
            ]
        }
    ]
}

Specification

{
    "type": "event_changed_if",
    "value": true
}

Name	Required	Description
`type`	Required	`"event_changed_if"` or `"event_changed_unless"`
`value`	Required	`true` or `false`
`description`	Optional	A human-readable comment

Tip

event_changed_unless is designed to prevent Function Keys Modifications from changing fx keys which are changed in Complex Modifications (e.g., Change command+e to f2).

Placeholder Developer is shown in Security & Privacy System Preferences

Mon, 01 Jan 0001 00:00:00 +0000

Note

This page is for macOS 10.15 Catalina, not macOS 11 Big Sur or later.

“.Karabiner-VirtualHIDDevice-Manager” is usually shown in Security & Privacy System Preferences when macOS requires your approval.

However, “Placeholder Developer” will be shown due to a macOS issue if you meet all of the following criteria:

You are using macOS Catalina (10.15)
Multiple system software are waiting your approval.

Workarounds

In this case, you can choose one of the following three options to use Karabiner-Elements:

Show log messages

Mon, 01 Jan 0001 00:00:00 +0000

You can confirm log messages on Log tab.

Warnings appear with a yellow background.

Errors appear with a red background.

Advanced topic

The log files are placed at:

System logs

/var/log/karabiner/core_service.log
/var/log/karabiner/virtual_hid_device_service.log

User logs

~/.local/share/karabiner/log/console_user_server.log
~/.local/share/karabiner/log/core_service.log
/var/log/karabiner/session_monitor.{uid}.log

The location of the configuration file

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements stores the user configuration in a JSON file located at ~/.config/karabiner/karabiner.json.

However, you may want to place the configuration file elsewhere, for example, to sync it automatically across multiple machines or to manage it under version control.

In such cases, you can move the karabiner.json configuration file to a different directory by using a symbolic link.

Important

Ensure you create a symbolic link to the ~/.config/karabiner directory, not directly to the karabiner.json file.

to.lazy

Mon, 01 Jan 0001 00:00:00 +0000

to.lazy is true or false. The default value is false.

If to.lazy is true and to.key_code is modifier flag such as "key_code": "left_shift", the to.key_code acts as lazy modifier.

The lazy modifier does not send own key events until another key is pressed together.

Tip

The lazy modifier is designed using with to_if_alone or key combinations such as changing left_control + h to delete_or_backspace in order to suppress unnecessary modifier key events.

Change app icon

Mon, 01 Jan 0001 00:00:00 +0000

You can change the icons that appear in the Finder, Launchpad, Dock, etc from Settings > UI.

Note

The icon in Dock will not reflect changes while the application is open. So, you should close and reopen the application to update the icon in Dock.

Privacy

Mon, 01 Jan 0001 00:00:00 +0000

Data handling

Security and privacy protection are important parts of the Karabiner-Elements architecture. Karabiner-Elements does not collect your keystrokes, configuration data, usage statistics, or other personal data.

Data not collected

Karabiner-Elements does not transmit your personal data outside your Mac. The following data is never sent externally:

Your keystrokes
Your configuration data
Your usage statistics
Other personal data, except for the information required to check for updates

Data received when checking for updates

When Karabiner-Elements checks for updates, the update server receives a standard web request.

Caps Lock LED not working

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements has a setting to disable caps lock LED control.

If your caps lock LED is not working properly, this setting may be enabled, so check the Manipulate caps lock LED setting in the Devices tab.

Contact

Mon, 01 Jan 0001 00:00:00 +0000

Reporting Bugs, Feature requests

Please post an issue to GitHub.

Karabiner-Elements
KE-complex_modifications (About complex modifications)

Required information with bug reports

Please fill your information when you send bug reports:

Required information

macOS version:
Karabiner version:
(You can confirm the version in “Update” tab in Karabiner Settings.)
Your Mac hardware:
Your keyboard hardware:

Example:

macOS version: macOS 26.4.1
Karabiner version: Karabiner-Elements 16.0.0
Your Mac hardware: MacBook Pro (M3 Pro)
Your keyboard hardware: Corne V4 Cherry

Other

Send a message to author of Karabiner-Elements.

Export and import configuration

Mon, 01 Jan 0001 00:00:00 +0000

You can export and import configuration by copying karabiner.json file to another machine.

Export

Open config folder from Karabiner-Elements Settings > Misc.
Configuration folder will be opened by Finder. Copy the karabiner.json file.

Import

Open config folder from Karabiner-Elements Settings > Misc.
Replace karabiner.json with the exported file.
(The configuration file will be reloaded automatically.)

External JSON generators

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements configuration generators:

GokuRakuJoudo
- Goku generates karabiner.json from well designed edn format file.
Karabiner Complex Modification
- The web UI for creating json of complex modification rules.
Karabiner::CompModGenerator
- Raku module for easily bulk generating and regenerating complex modification from pre-defined templates.
Jsonnet
- A data templating language as a simple extension of JSON to generate config data with the benefit to organize, simplify, unify, and manage sprawling configurations.
karabiner.ts
- Write complex modification rules in TypeScript with strong typing.
Karabiner-Human-Config
- The easiest way to write Karabiner-Elements configuration files ever! Identify bundles by just the app name, add comments, nest configurations, use aliases, and much more.

to.repeat

Mon, 01 Jan 0001 00:00:00 +0000

to.repeat is true or false. The default value is true.

The key repeating will be suppressed if to.repeat is false.

Tip

to.repeat affects key_up event sending timing as follows.

If to.repeat is true:
- key_up event is sent when you release the key.
If to.repeat is false:
- key_down and key_up events are sent when you press the key.

Example

To prevent key repeats like “hellooooooooo” when holding down a key, add “repeat”: false to the final key event in the sequence.

About Unsafe Configuration

Mon, 01 Jan 0001 00:00:00 +0000

There are several settings that cannot be enabled by default in the GUI to prevent improper configuration which breaks macOS operation.

Although never recommended, enabling Unsafe Configuration from the Expert tab allows you the following operations.

If you want to enable the unsafe configuration, remember how to start up your Mac in safe mode. You can restore the settings in safe mode even if you make a mistake.

How to enable unsafe configuration

Enabled operations

Allow to modify Apple pointing devices

You can enable Apple pointing devices from the Devices tab.

Downgrade

Mon, 01 Jan 0001 00:00:00 +0000

If you face a problem and you want to revert previous version, please downgrade Karabiner-Elements as follows.

Uninstall Karabiner-Elements from uninstaller.
Download a previous version from here.
Install again.

Advanced topic

The first uninstallation is required to remove the virtual driver. Since virtual drivers cannot be directly downgraded, if you want to install an older version, you need to remove a newer version beforehand.

Pricing

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements is an open source software and you can use it without any purchases.

Supporting this project

This project accepts your funding via GitHub Sponsors or PayPal.

For donors

I appreciate all donors. I received your donations!

I’m afraid I don’t have enough time to reply for donors.
(I’m giving priority to develop Karabiner-Elements at the moment.)

May 3, 2026
Takayama Fumihiko

Monthly or One-time (GitHub Sponsors)

Takayama Fumihiko
@tekezo

Open GitHub Sponsors page

One-time (PayPal)

Note: This is effectively a donation but it has taken the form of software fee because of Japanese law and the constraints on government regulation.

Settings window is shown at login

Mon, 01 Jan 0001 00:00:00 +0000

If you manually registered Karabiner-Elements to Open at Login, the settings window will always appear at startup.

Karabiner-Elements will start automatically via launchd even if it is not in Open at Login, so remove it from your Open at Login.

Open System Settings.
Open General > Login Items.
Remove Karabiner-Elements from Open at Login.

Caution

Do not disable Karabiner-Elements.app in Allow in the Background. It’s a required setting for Karabiner-Elements to work.

to.halt

Mon, 01 Jan 0001 00:00:00 +0000

to.halt is specified in to_if_alone or to_if_held_down and is used to cancel subsequent actions like to_after_key_up or to_delayed_action.

Example

The following json changes holding tab key to mute.

The halt in to_if_held_down suppresses to_after_key_up when mute is sent.

💡 How to use this example

{
    "description": "Mute when tab is held down",
    "manipulators": [
        {
            "type": "basic",
            "from": { "key_code": "tab" },
            "to_after_key_up": [{ "key_code": "tab" }],
            "to_if_held_down": [
                {
                    "consumer_key_code": "mute",
                    "halt": true
                }
            ]
        }
    ]
}

Input symbols are different from the key code name on non-ANSI keyboards

Mon, 01 Jan 0001 00:00:00 +0000

This is the intended behavior.

The key code name using in Karabiner-Elements is HID usage name, which is similar to a scancode. This is close to the physical key location on the ANSI layout keyboard.

For this reason, there are mismatches of symbols actually input and key code names on non-ANSI keyboards.

Determining which characters are to be input by keyboard event is the later step in the processing flow of macOS. Karabiner-Elements changes input events on a layer closer to the hardware, which is why it works like this.

Release notes

Mon, 01 Jan 0001 00:00:00 +0000

Karabiner-Elements 16.0.0

📦 Download
📅 Release date
- May 3, 2026
🔔 Important Notes
- Karabiner-Core-Service now requires Accessibility permission. Please enable it in System Settings.
✨ New Features
- frontmost_application_if can now detect overlay windows, such as Spotlight, using the Accessibility API.
- variable_if now supports the following variables, making it possible to change behavior depending on whether the focused element is a text area.
  - accessibility.focused_ui_element.role_string
  - accessibility.focused_ui_element.subrole_string
  - accessibility.focused_ui_element.title_string
  - accessibility.focused_ui_element.window_position_x
  - accessibility.focused_ui_element.window_position_y
  - accessibility.focused_ui_element.window_size_height
  - accessibility.focused_ui_element.window_size_width
- You can now generate JSON for Complex Modifications rules by writing JavaScript.
- Added an “Add your own rule using JavaScript” button to the complex modifications viewer.
- Added an “Open in external editor” button to the complex modifications editor.
- Added a “Clear user variables” button to EventViewer. (Thanks to @BarakXYZ)
- Added to.to_if_other_key_pressed. It’s now possible to implement “Change option+tab to command+tab” in a more natural way and reliable way.
- Added to.send_user_command. By using it together with an external server built with Karabiner-Elements-user-command-receiver, you can execute any action from Karabiner-Elements with low latency. (Thanks to @nikivdev)
- Added to.from_event, allowing pressed events to be passed through as-is.
- Added relative_to and fallback_to to software_function.set_mouse_cursor_position.
- Added Enable CGEventTap fallback setting to Expert tab. Enable receiving events via CGEventTap for keyboards where IOHIDDeviceOpen fails for some reason.
- Added Setup tab to Settings.
🐛 Bug Fixes
- Fixed an issue where modifier keys could remain stuck when physical keyboard events were missed during capture.
- Fixed an issue where reordering in Complex Modifications and Profiles didn’t work properly when dragging while scrolling.
- Fixed an issue where variables in expressions were not properly initialized when unset.
⚡️ Improvements
- Changed to call exit instead of abort to suppress crash reports when a fatal error prevents CFRunLoop from running in background processes.
- If Accessibility permission makes Input Monitoring permission unnecessary, only Accessibility permission will be requested.

Karabiner-Elements 15.9.0

📦 Download
📅 Release date
- Jan 19, 2026
🐛 Bug Fixes
- Fixed an issue in v15.8.0 where the update notification window was not shown when updates were checked in the background.

Karabiner-Elements 15.8.0

📦 Download
📅 Release date
- Jan 18, 2026
💥 Breaking changes
- Changed the default behavior of f6 to the Do Not Disturb key.
✨ New Features
- Added open_application.frontmost_application_history_exclusion_bundle_identifiers and open_application.frontmost_application_history_exclusion_file_paths.
- Added the following options to karabiner_cli:
  - --list-multitouch-extension-variables
  - --watch-multitouch-extension-variables
- Added macOS log messages viewer to Settings.
🐛 Bug Fixes
- Fixed an issue where the sticky modifier indicator could continue to be displayed even after being disabled in the settings.
- Fixed an issue where karabiner_machine_identifier was not set correctly during a clean install.
⚡️ Improvements
- Removed the probable stuck key detector since we’ve confirmed that, on supported versions of macOS, seizing the device while keys are held down no longer causes any issues.
- Added an alert that appears if communication with Karabiner-VirtualHIDDevice-Daemon is not possible.
- Improved the automatic recovery behavior from inter-process communication failures.
- Improved open_application to exclude non-application bundles from frontmost_application_history_index.
- Move system extensions viewer to Settings from EventViewer.
- Updated EventViewer to properly display modifier flags for pointing button events.
- Improved MultitouchExtension to disable PreventUserIdleSystemSleep before the system goes to sleep.
- Supported the following keys:
  - generic_desktop::do_not_disturb
- Sparkle Framework has been updated.

Karabiner-Elements 15.7.0

📦 Download
📅 Release date
- Nov 10, 2025
🔔 Important Notes
- After upgrading, make the following changes in System Settings:
  - Enable Karabiner-Elements Privileged Daemons v2 under App Background Activity.
  - Enable Karabiner-Core-Service under Input Monitoring.
- karabiner_grabber has been renamed to Karabiner-Core-Service. Full Disk Access isn’t necessary if you’re just using the standard setup. However, if you’ve manually moved the karabiner.json configuration file to another location, you might need to grant Full Disk Access to Karabiner-Core-Service.
💥 Breaking changes
- The file /Library/Application Support/org.pqrs/tmp/karabiner_grabber_devices.json is no longer updated. You can still use EventViewer and karabiner_cli to check connected devices.
🐛 Bug Fixes
- Fixed an issue where modifiers in a pending-release state under Complex Modifications were not being released when all keys were lifted.
⚡️ Improvements
- Fixed an issue on macOS 26.1 where karabiner_grabber was missing from the Input Monitoring list in System Settings. Instead, Karabiner-Core-Service will now be shown.
- The error message in the Complex Modification Editor is now copyable.

Karabiner-Elements 15.6.0

📦 Download
📅 Release date
- Nov 3, 2025
💥 Breaking changes
- The file /Library/Application Support/org.pqrs/tmp/karabiner_grabber_manipulator_environment.json is no longer updated. You can still use EventViewer to check current variable values.
🐛 Bug Fixes
- Fixed an issue in EventViewer where new events were not added while the “Unknown Events” tab was open.
✨ New Features
- Added a “Temporarily turns off all Karabiner-Elements modifications” toggle to EventViewer.
- Added a feature that lets you set environment variables via /Library/Application Support/org.pqrs/config/karabiner_environment.
- Added support for devices that expose the Programmable Buttons usage on the Consumer Usage Page. (e.g., VEC USB Footpedal)
- Added set_variable.expression and set_variable.key_up_expression.
- Added expression_if and expression_unless.
- Added system.now.milliseconds to variables.
- Added integer_value to the from event definition.
⚡️ Improvements
- Updated the app icon for macOS 26.
- Added support for Liquid Glass.
- Reduced the load on karabiner_grabber. In particular, CPU usage is lower when handling high-frequency events (e.g., mouse input).
- Improved handling of the ignore_vendor_events setting. The UI already prevented enabling this for Apple devices, and now, even if you manually set ignore_vendor_events in karabiner.json, vendor events for Apple devices will always be processed regardless of the setting.
- Adjusted the layouts in Settings and EventViewer to show more information.
- Supported the following keys:
  - generic_desktop::system_app_menu
  - consumer_key_code::microphone
  - consumer_key_code::selection
  - pointing_button::button33 … pointing_button::button255
- Sparkle Framework has been updated.

Karabiner-Elements 15.5.0

📦 Download
📅 Release date
- Jul 29, 2025
🐛 Bug Fixes
- Fixed an issue where the “Use all F1, F2, etc. keys as standard function keys” setting wasn’t correctly detected in some environments.
- Fixed an issue where some buttons were hard to see in Dark Mode.
✨ New Features
- Added Show additional menu items option in UI tab.
- Added macOS also remaps modifier keys warning.
- Added karabiner.json couldn't be loaded due to a parse error alert.
⚡️ Improvements
- Suppress forced icon updates (e.g., for Karabiner-Elements.app) during karabiner_grabber startup.

Karabiner-Elements 15.4.0

📦 Download
📅 Release date
- Jun 29, 2025
🐛 Bug Fixes
- Fixed an overflow issue with the mouse key movements.
- Fixed an issue that the fn key is unintentionally tapped when use the media keys if “Use all F1, F2, etc. keys as standard function keys” is enabled.
✨ New Features
- Supported headset buttons.
- Added Ignore vendor events option to device settings in Devices tab.
- Added XY movement multiplier and Wheels multiplier to the mouse settings in Devices tab.
- Added frontmost_application_history_index option into open_application.
- Added conditions option into to.
- Added Filter useless events from specific devices option in Expert tab.
- Added Reorder same timestamp input events to prioritize modifiers in Expert tab.
- Added a toggle to EventViewer for monitoring events.
⚡️ Improvements
- Migrated to the SwiftUI life cycle.
- Migrated to Swift 6.
- Improved to_delayed_action behavior to use the modifier flags of the time the key is pressed, when sending events.
- Supported the following keys:
  - consumer::ac_zoom_out
  - consumer::ac_zoom_in
  - generic_desktop::system_sleep
- Added support for new consumer keys (Thanks to @indygriffiths):
  - { "consumer_key_code": "stop" }
  - { "consumer_key_code": "bass_boost" }
  - { "consumer_key_code": "loudness" }
  - { "consumer_key_code": "bass_increment" }
  - { "consumer_key_code": "bass_decrement" }
  - { "consumer_key_code": "ac_search" }
- The implicit conversion of Touch ID to the Lock key has been modified to work even when modifiers are held down.

Karabiner-Elements 15.3.0

📦 Download
📅 Release date
- Oct 28, 2024
🐛 Bug Fixes
- Fixed the behavior when setting the function keys to act as regular f1…f12 keys instead of media controls.
✨ New Features
- Added the following variables for variable_if, variable_unless:
  - system.scroll_direction_is_natural
  - system.use_fkeys_as_standard_function_keys
⚡️ Improvements
- The key names in the Function Keys settings became clearer when “Use all F1, F2, etc. keys as standard function keys” is enabled.

Details of Breaking Changes in v15.1.0

to.hold_down_milliseconds

Mon, 01 Jan 0001 00:00:00 +0000

to.hold_down_milliseconds is an integer value. The default value is 0.

The value is an interval of key_down and key_up when key_down and key_up events are sent at the same time such as multiple to events.

Note

Generally to.hold_down_milliseconds is used with "key_code": "caps_lock".

Example

The following json changes caps_lock key to sending caps_lock key_down, wait 200 milliseconds, caps_lock key_up.

💡 How to use this example

{
    "description": "Disable the accidental keystroke prevention of Caps Lock",
    "manipulators": [
        {
            "type": "basic",
            "from": {
                "key_code": "caps_lock",
                "modifiers": {
                    "optional": ["any"]
                }
            },
            "to": [
                {
                    "key_code": "caps_lock",
                    "hold_down_milliseconds": 200
                },
                {
                    "key_code": "vk_none"
                }
            ]
        }
    ]
}

Note

vk_none is needed to ignore the hardware key_up event. Without adding vk_none, a key_down and key_up event for caps_lock will be sent for each hardware key_down and key_up event, meaning hold_down_milliseconds will not be applied between the key_down and key_up events.

Compatibility with Logitech Logi Options+: Fn keys

Mon, 01 Jan 0001 00:00:00 +0000

This was discovered when using an MX Keys keyboard with the “Logi Options+” software. While Karabiner Elements is running, the Logitech specific function keys (such as Fn-esc to toggle between function keys and media keys and f1, f2, f3 to switch between inputs) are not recognized.

The solution is to edit karabiner.json such that the "fn_function_keys" array is empty:

    "fn_function_keys": []

Credit: https://github.com/pqrs-org/Karabiner-Elements/issues/1450#issuecomment-1013932206

to.conditions

Mon, 01 Jan 0001 00:00:00 +0000

When conditions are specified in to, the event is sent only if the conditions are satisfied.

Note

This configuration is intended for highly specific use cases.

If your goal is to define a setting such as “Enable only in Finder”, you should use conditions at a higher level in the hierarchy rather than to.conditions.

to.conditions is available since Karabiner-Elements 15.3.7.

Example

In this example, conditions are used inside to_if_invoked and to_if_canceled to prevent the q key from being sent via to_delayed_action when the escape key is pressed.

Karabiner-Elements

Breaking changes introduced by the version upgrade

Karabiner-Elements 15.1.0

Modifiers

Function Keys

Fn Key (Globe Key)

Required macOS settings

Enable background services

Driver alert keeps showing up

Team ID and Bundle ID

About "Device is ignored temporarily" alert

cg_event_double_click

Change a key to another key

File locations

from.any

frontmost_application_if, frontmost_application_unless

Example

Specification

Multiple bundle identifiers or file paths

How to change mouse buttons

Installation

Install Karabiner-Elements

Installed files

System files

User files

Letter key holding modifier

JavaScript version

JSON version

MultitouchExtension integration

Example

Variables

Quit

to.shell_command

Examples

Open application

Execute shell from file

"Fumihiko Takayama" is shown in Login Items

Information for those who want to know more

Restart

How to use sticky modifier keys

device_if, device_unless, device_exists_if, device_exists_unless

Example

Specification

type

identifiers

Features

Core features

Modification examples

Typical complex_modifications examples

Expert complex_modifications examples

Current limitations

from.modifiers

from.modifiers.mandatory

from.modifiers.optional

How to disable caps lock delay

Disable the accidental keystroke prevention of Caps Lock

Implicit behavior

Share state of modifier keys with all connected keyboards

Apply special handling to specific keys

iokit_power_management_sleep_system

Examples

Specification

Karabiner-Elements stopped working after macOS update

Letter key release order modifier

JavaScript version

JSON version

Security

Processes

Process list

to.select_input_source

Example

Specification

Investigate the input source identifiers

Typical complex_modifications examples

Swap ; and :

Change control-h to delete

Change mouse button4 and button5 to back and forward

Uninstall

Use more complex modifications

Virtual modifier

`type`

`identifiers`

`from.modifiers.mandatory`

`from.modifiers.optional`

Swap `;` and `:`

Change `control-h` to `delete`

`detect_key_down_uninterruptedly`

`input_sources`

custom `*.json` file in ~/config/karabiner/assets/complex_modifications