arunvelsriram/yabai-help-overlay

Help overlay for yabai, inspired by regolith-linux's help overlay.

yabai-help-overlay

Help overlay for yabai inspired by regolith-linux's help overlay.

How it works?

The overlay (basically a window) is populated using comments provided in the skhd configuration ~/.skhdrc.

Each skhd config has a comment in the below format:

# group : description
skhd config

# group : description
skhd config

For example:

# Launch : Terminal
hyper - return : open /Applications/Alacritty.app
# Launch : Browser
hyper - b : yabai-utils open-firefox

# Window : Focus top window
hyper - k : yabai -m window --focus north
...

My .skhdrc for reference.

Install

1. Download the package and move the application to /Applications
2. To open the help overlay using a keyboard shortcut add the below config to ~/.skhdrc

# Launch : Help
hyper - f1 : yabai -m rule --add app="^yabai-help-overlay$" sticky=on layer=above manage=off && open /Applications/yabai-help-overlay.app

hyper + f1 shows the overlay

yabai-help-overlay's Issues

Is it possible to add system and standard application shortcuts?

e.g. for

# Session : Lock Screen
# ctrl + cmd - q 
# Session : Log out
# shift + cmd - q

# Application : Quit
# cmd + q :
# Application : Hide
# cmd - h
# Application : Minimize
# cmd - m

etc.