Skip to content

Integrations ‐ skhd

Anze edited this page Mar 15, 2024 · 5 revisions

KeyClu currently supports reading skhdrc format file for hotkeys, but there are some limitations in place.

By default files read in a exact order:

$XDG_CONFIG_HOME/skhd/skhdrc
$HOME/.config/skhd/skhdrc
$HOME/.skhdrc

The order of file reading can be adjusted as needed. Please refer to additional configuration for more details.

Supported Shortcuts

  • keys as literals, e.g. a or 1
  • keys as kVK_ANSI_A
  • keys as hex, e.g. 0x2b

Not Supported elements

  • multiline comment
  • multiline keys
  • application specific bindings format
  • mode switching format
  • special keys e.g. sound_up etc (check references)

How To List

To list your shortcuts defined in skhd, you need to add comment right before shortcut.

Example 1

Default comment

# open qutebrowser
cmd + shift - return : ~/Scripts/qtb.sh

In this case it would be listed under Common category/section with title open qutebrowser.

Example 2

KeyClu comment

#KeyClu[Window management]: Move/Focus window west
alt - h : yabai -m window --focus west || yabai -m display --focus west

In this case it would be listed under Window management category/section with title Move/Focus window west.

References