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

bin+lib heimdall-cli

A simple hotkey deamon. Primarly tested on MacOS

7 releases

0.1.7 Dec 28, 2023
0.1.6 Dec 26, 2023
0.1.3 Nov 26, 2023

#700 in Hardware support

Download history 2/week @ 2023-12-28 5/week @ 2024-02-22 4/week @ 2024-02-29 34/week @ 2024-03-28 17/week @ 2024-04-04

51 downloads per month

MIT license

13KB
190 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

~10–25MB
~378K SLoC