A human-readable configuration generator for Karabiner-Elements #6
Description
Hi @al-ce,
I’m currently working on simplifying the configuration generation process. As a new user, I’m eager to learn about the rules and features that user's frequently uses. Could you please share some insights or resources that could help me understand and implement these effectively?
https://github.com/nrjdalal/karabiner-human-config
Karabiner-Human-Config
A human-readable configuration generator for Karabiner-Elements
Creating configuration files for Karabiner-Elements can be challenging. With Karabiner-Human-Config (KHC), you can effortlessly generate your own configuration files using human-readable/understandable syntax.
Usage
Just create a new configuration file karabiner.human.json:
{
"fn": { "to": "fn", "to_if_alone": "left_command tab" },
"fn spacebar": "left_command spacebar",
"fn v": "$ open '/Applications/Visual Studio Code.app'",
"hyper spacebar": "left_command spacebar",
"caps_lock": { "to": "hyper", "to_if_alone": "100 caps_lock" }
}And run the following command:
npx karabiner-human-configAnd voila! From 5 lines to 140 lines of configuration in just a few seconds.
Generated: karabiner.json
{
"global": {
"show_in_menu_bar": false
},
"profiles": [
{
"complex_modifications": {
"rules": [
{
"manipulators": [
{
"type": "basic",
"description": "fn",
"from": {
"key_code": "fn"
},
"to": [
{
"key_code": "fn"
}
],
"to_if_alone": [
{
"key_code": "tab",
"modifiers": [
"left_command"
]
}
]
}
]
},
{
"manipulators": [
{
"type": "basic",
"description": "fn spacebar",
"from": {
"key_code": "spacebar",
"modifiers": {
"mandatory": [
"fn"
]
}
},
"to": [
{
"key_code": "spacebar",
"modifiers": [
"left_command"
]
}
]
}
]
},
{
"manipulators": [
{
"type": "basic",
"description": "fn v",
"from": {
"key_code": "v",
"modifiers": {
"mandatory": [
"fn"
]
}
},
"to": [
{
"shell_command": "open '/Applications/Visual Studio Code.app'"
}
]
}
]
},
{
"manipulators": [
{
"type": "basic",
"description": "left_command left_control left_option left_shift spacebar",
"from": {
"key_code": "spacebar",
"modifiers": {
"mandatory": [
"left_command",
"left_control",
"left_option",
"left_shift"
]
}
},
"to": [
{
"key_code": "spacebar",
"modifiers": [
"left_command"
]
}
]
}
]
},
{
"manipulators": [
{
"type": "basic",
"description": "caps_lock",
"from": {
"key_code": "caps_lock"
},
"to": [
{
"key_code": "left_shift",
"modifiers": [
"left_command",
"left_control",
"left_option"
]
}
],
"to_if_alone": [
{
"hold_down_milliseconds": 100,
"key_code": "caps_lock"
}
]
}
]
}
]
},
"name": "nrjdalal",
"selected": true,
"virtual_hid_keyboard": {
"keyboard_type_v2": "ansi"
}
}
]
}
The generated configuration, will be logged to the console.
You can then manually copy and paste it into your karabiner.json file.
Advanced Usage for From Events
Optional Modifiers
Use | to specify a shell command.
{
- "fn spacebar: "left_command spacebar"
+ "fn spacebar | any": "left_command spacebar"
}Generated: karabiner.json
{
"global": {
"show_in_menu_bar": false
},
"profiles": [
{
"complex_modifications": {
"rules": [
{
"manipulators": [
{
"type": "basic",
"description": "fn spacebar",
"from": {
"key_code": "spacebar",
"modifiers": {
"mandatory": [
"fn"
],
"optional": [
"any"
]
}
},
"to": [
{
"key_code": "spacebar",
"modifiers": [
"left_command"
]
}
]
}
]
}
]
},
"name": "nrjdalal",
"selected": true,
"virtual_hid_keyboard": {
"keyboard_type_v2": "ansi"
}
}
]
}
Advanced Usage for To Events
Shell Commands
Use $ to specify a shell command.
{
- "fn spacebar": "left_command spacebar"
+ "fn spacebar": "$ open -a 'Google Chrome'"
}Generated: karabiner.json
{
"global": {
"show_in_menu_bar": false
},
"profiles": [
{
"complex_modifications": {
"rules": [
{
"manipulators": [
{
"type": "basic",
"description": "fn spacebar",
"from": {
"key_code": "spacebar",
"modifiers": {
"mandatory": [
"fn"
]
}
},
"to": [
{
"shell_command": "open -a 'Google Chrome'"
}
]
}
]
}
]
},
"name": "nrjdalal",
"selected": true,
"virtual_hid_keyboard": {
"keyboard_type_v2": "ansi"
}
}
]
}
Specify Delay and Flags
Use lazy, repeat, halt to set flags. Or number to specify a delay.
Use only what you need. If you don't need a delay or any flags, don't specify them.
{
- "fn spacebar": "left_command spacebar"
+ "fn spacebar": "100 lazy repeat halt left_command spacebar"
}Generated: karabiner.json
{
"global": {
"show_in_menu_bar": false
},
"profiles": [
{
"complex_modifications": {
"rules": [
{
"manipulators": [
{
"type": "basic",
"description": "fn spacebar",
"from": {
"key_code": "spacebar",
"modifiers": {
"mandatory": [
"fn"
]
}
},
"to": [
{
"lazy": true,
"repeat": true,
"halt": true,
"hold_down_milliseconds": 100,
"key_code": "spacebar",
"modifiers": [
"left_command"
]
}
]
}
]
}
]
},
"name": "nrjdalal",
"selected": true,
"virtual_hid_keyboard": {
"keyboard_type_v2": "ansi"
}
}
]
}
Specify Multiple Events
Use object insetad of string { to: ..., to_if_alone: ... } to specify multiple to events.
{
- "fn spacebar": "left_command spacebar"
+ "fn": { "to": "fn", "to_if_alone": "left_command tab" }
}Generated: karabiner.json
{
"global": {
"show_in_menu_bar": false
},
"profiles": [
{
"complex_modifications": {
"rules": [
{
"manipulators": [
{
"type": "basic",
"description": "fn",
"from": {
"key_code": "fn"
},
"to": [
{
"key_code": "fn"
}
],
"to_if_alone": [
{
"key_code": "tab",
"modifiers": [
"left_command"
]
}
]
}
]
}
]
},
"name": "nrjdalal",
"selected": true,
"virtual_hid_keyboard": {
"keyboard_type_v2": "ansi"
}
}
]
}