https://github.com/arunvelsriram/yabai-help-overlay

Help overlay for yabai, inspired by regolith-linux's help overlay.
https://github.com/arunvelsriram/yabai-help-overlay

macapp osx skhd yabai

Last synced: 21 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/arunvelsriram/yabai-help-overlay
• Owner: arunvelsriram
• License: mit
• Created: 2020-12-26T12:47:17.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-02T11:05:43.000Z (almost 4 years ago)
• Last Synced: 2024-08-09T17:30:11.741Z (3 months ago)
• Topics: macapp, osx, skhd, yabai
• Language: Swift
• Homepage: https://github.com/arunvelsriram/yabai-help-overlay
• Size: 1.89 MB
• Stars: 22
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# yabai-help-overlay

Help overlay for [yabai](https://github.com/koekeishiya/yabai) inspired by [regolith-linux](https://regolith-linux.org/)'s help overlay.

![yabai-help-overlay screenshot](screenshot.png)

## How it works?

The overlay (basically a window) is populated using comments provided in the [skhd](https://github.com/koekeishiya/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`](https://github.com/arunvelsriram/dotfiles/blob/master/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