blukey

Crates.ioblukey
lib.rsblukey
version0.0.2-rc0
created_at2024-12-07 11:11:34.890216+00
updated_at2024-12-08 16:10:35.32667+00
descriptionA Linux daemon for creating custom keyboard shortcuts that can execute shell commands.
homepagehttps://github.com/shashankx86/blukey
repositoryhttps://github.com/shashankx86/blukey
max_upload_size
id1475523
size50,539
Shashank Shekhar Pandey (shashankx86)

documentation

README

Blukey

A CLI to set your custom key combo to perform custom key actions.

Installation

cargo install blukey

Usage

blukey <COMMAND>

Commands:
  start         Start the keyboard monitor
  stop          Stop the daemon
  key           Manage key combinations
  config-path   Show config file location

Key Commands:
  key new       Register a new key combination
  key list      List all registered key combinations

Examples

  1. Register a new shortcut:
sudo blukey key new
# Follow the prompts to press keys and enter command
  1. Start the monitor:
sudo blukey start
  1. List registered shortcuts:
blukey key list

Configuration

Configuration is stored in ~/.blukey.json. The format is:

{
  "DEMON": false,
  "KEYS": {
    "KEY_LEFTCTRL+KEY_C": "echo 'Ctrl+C pressed'"
  }
}

License

MIT License - See LICENSE for details.

Commit count: 25

cargo fmt