heimdall-cli

Crates.ioheimdall-cli
lib.rsheimdall-cli
version0.1.11
sourcesrc
created_at2023-11-25 13:45:42.206007
updated_at2024-07-07 13:27:41.820151
descriptionA simple hotkey daemon. Primarily tested on MacOS
homepagehttps://github.com/uzaaft/heimdall
repositoryhttps://github.com/uzaaft/heimdall
max_upload_size
id1048302
size46,205
Uzair Aftab (Uzaaft)

documentation

https://github.com/uzaaft/heimdall

README

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


Commit count: 42

cargo fmt