https://github.com/uzaaft/heimdall
A skhd alternative
https://github.com/uzaaft/heimdall
hotkey-daemons hotkeys macos skhd yabai
Last synced: 5 months ago
JSON representation
A skhd alternative
- Host: GitHub
- URL: https://github.com/uzaaft/heimdall
- Owner: Uzaaft
- Created: 2023-11-06T07:24:24.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-03-16T17:12:59.000Z (7 months ago)
- Last Synced: 2025-05-08T23:14:58.982Z (5 months ago)
- Topics: hotkey-daemons, hotkeys, macos, skhd, yabai
- Language: Rust
- Homepage:
- Size: 193 KB
- Stars: 16
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Heimdall
### Status: Very alpha, and WIP. The following docs may be uncomplete. Feel free to open PR's if something is missing.
## Features:
- An extensible hotkey daemon which supports multiple modifiers, and custom commands.
## Installation
To get started, simply clone the whole repository, and build it with Rust:
$ cargo install heimdall-cli
## Getting started
To get started with Heimdall, follow these steps:
1. Create a config file with the path `$XDG_CONFIG_HOME/heimdall/config.toml`
The config file has the following format:
```toml
[[bindings]]
key = "C"
modifiers = ["Ctrl", "Shift"]
command = "echo hello"
[[bindings]]
key = "D"
modifiers = ["Ctrl"]
command = "osascript -e 'display notification with title \"Hello 👋!\" subtitle \"Hello from Heimdall 😊\" sound name \"Crystal\"'"
```
2. Start heimdall with the `heim` command. If you want to start the service
$ heim --start-service