Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install blukey

It will make the blukey command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall blukey uninstalls.

Back to the crate overview.

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

sudo blukey key new
# Follow the prompts to press keys and enter command

Start the monitor:

sudo blukey start

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.