#daemon #hotkey #macos #command #extensible #modifiers #heimdall

bin+lib heimdall-cli

A simple hotkey daemon. Primarily tested on MacOS

11 releases

0.1.11 Jul 7, 2024
0.1.10 Jun 15, 2024
0.1.9 May 4, 2024
0.1.8 Apr 29, 2024
0.1.3 Nov 26, 2023

#1979 in Parser implementations

Download history 22/week @ 2024-07-23 6/week @ 2024-09-10 3/week @ 2024-09-17 17/week @ 2024-09-24 1/week @ 2024-10-01

750 downloads per month

MIT license

14KB
161 lines

Heimdall

Note: This project is a WIP, and the following docs may be uncomplete.

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:
    [[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


Dependencies

~11–27MB
~410K SLoC