otty / dotfiles

All tools/Karabiner-Elements

Karabiner-Elements

karabiner-elements

A powerful and stable keyboard customizer for macOS.

Detected by karabiner_cli | macOS |karabiner-elements.pqrs.org

Sync it karabiner-elements.toml

Sync rules

What travels, what stays, what never leaves

Karabiner-Elements in your home directory Every rule on this page, by file

· karabiner.json Sync

· assets/complex_modifications/ Sync

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/karabiner-elements.tomlThe file this page is generated from

id = "karabiner-elements"

name = "Karabiner-Elements"

homepage = "https://karabiner-elements.pqrs.org"

description = "A powerful and stable keyboard customizer for macOS."

# The apple-touch-icon from the project's site.

icon = "https://karabiner-elements.pqrs.org/favicons/apple-touch-icon-180x180.png"

# Karabiner-Elements ships a command line tool, and the Homebrew cask puts it

# on the PATH: binary "/Library/Application Support/org.pqrs/Karabiner-Elements/

# bin/karabiner_cli", target "$HOMEBREW_PREFIX/bin/karabiner_cli"

# (https://formulae.brew.sh/api/cask/karabiner-elements.json). The docs site has

# a "Command line interface" page for it as well.

detect = ["karabiner_cli"]

platforms = ["macos"]

# https://karabiner-elements.pqrs.org/docs/json/location/ — "File locations":

# ~/.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.

# The path is a literal ~/.config even on macOS: the docs spell it out that way

# and the same page explains that Karabiner-Elements watches the parent

# directory ~/.config/karabiner with the File System Events API. It is not

# [configHome], which would mean it followed $XDG_CONFIG_HOME — nothing in the

# documentation says it does. The Homebrew cask's zap list names the same

# directory (~/.config/karabiner).

paths = [

"~/.config/karabiner/karabiner.json",

"~/.config/karabiner/assets/complex_modifications/",

]

# The log directory the same page names, ~/.local/share/karabiner/log, is

# outside both paths above, so there is nothing to carve out of what is synced.

exclude = []

# A key remapper with no accounts: karabiner.json is profiles, simple and

# complex modifications, function key mappings and device settings.

secret = []

# No machine_lines, deliberately. The one hardware-shaped part of

# karabiner.json is profiles[].devices[], whose identifiers are the USB vendor

# and product ids of keyboards attached to this Mac — but a user with the same

# external keyboard on both machines wants those rules to follow, and the

# entries for hardware that is absent are inert rather than harmful. Stripping

# them would cost more than it saves, so the file syncs whole.

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/karabiner-elements. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these is generated from the same rules as this page.