feat: revamp hotkey to support custom bash script and IPC calls (#82)

Author: y3owk1n

README.md

@@ -323,12 +323,12 @@ See [`configs/default-config.toml`](configs/default-config.toml) for all availab
 ```toml
 [hotkeys]
 # all hotkeys can be disabled by either setting the key to "" or just commenting it out
-activate_hint_mode = "Ctrl+F"
-activate_hint_mode_with_actions = "Ctrl+G"
-activate_scroll_mode = "Ctrl+S"
+"Ctrl+F" = "hints"
+"Ctrl+G" = "hints_action"
+"Ctrl+S" = "scroll"
 ```
 
-You shoul be also able to just clear the keybind and bind it with something like skhd or any similar tools, since we exposes commands in the cli through IPC. For example in skhd:
+You should be also able to just clear the keybind and bind it with something like skhd or any similar tools, since we exposes commands in the cli through IPC. For example in skhd:
 
 ```bash
 ctrl - f : neru hints

cmd/neru/main.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"image"
 	"os"
+	"os/exec"
 	"os/signal"
 	"path/filepath"
 	"strings"
@@ -161,12 +162,15 @@ func NewApp(cfg *config.Config) (*App, error) {
 	if app.eventTap == nil {
 		log.Warn("Event tap creation failed - key capture won't work")
 	} else {
+
+		keys := make([]string, 0, len(cfg.Hotkeys.Bindings))
+		for k := range cfg.Hotkeys.Bindings {
+			keys = append(keys, k)
+		}
+
 		// Configure hotkeys that should pass through to the global hotkey system
-		app.eventTap.SetHotkeys(
-			cfg.Hotkeys.ActivateHintMode,
-			cfg.Hotkeys.ActivateHintModeWithActions,
-			cfg.Hotkeys.ActivateScrollMode,
-		)
+		app.eventTap.SetHotkeys(keys)
+
 		// Ensure event tap is disabled initially (only enable in active modes)
 		app.eventTap.Disable()
 	}
@@ -232,15 +236,15 @@ func (a *App) Run() error {
 	a.logger.Info("Neru is running")
 	fmt.Println("✓ Neru is running")
 
-	// Print configured hotkeys
-	if key := strings.TrimSpace(a.config.Hotkeys.ActivateHintMode); key != "" {
-		fmt.Printf("  Hint mode (direct): %s\n", key)
-	}
-	if key := strings.TrimSpace(a.config.Hotkeys.ActivateHintModeWithActions); key != "" {
-		fmt.Printf("  Hint mode (with actions): %s\n", key)
-	}
-	if key := strings.TrimSpace(a.config.Hotkeys.ActivateScrollMode); key != "" {
-		fmt.Printf("  Scroll mode: %s\n", key)
+	for k, v := range a.config.Hotkeys.Bindings {
+		toShow := v
+		if strings.HasPrefix(v, "exec") {
+			runes := []rune(v)
+			if len(runes) > 30 {
+				toShow = string(runes[:30]) + "..."
+			}
+		}
+		fmt.Printf("  %s: %s\n", k, toShow)
 	}
 
 	// Wait for interrupt signal with force-quit support
@@ -282,35 +286,67 @@ func (a *App) Run() error {
 
 // registerHotkeys registers all global hotkeys
 func (a *App) registerHotkeys() error {
-	// Hint mode hotkey (direct click)
-	if key := strings.TrimSpace(a.config.Hotkeys.ActivateHintMode); key != "" {
-		a.logger.Info("Registering hint mode hotkey", zap.String("key", key))
-		if _, err := a.hotkeyManager.Register(key, func() {
-			a.activateHintMode(false)
-		}); err != nil {
-			return fmt.Errorf("failed to register hint mode hotkey: %w", err)
-		}
-	}
+	// Note: Escape key for exiting modes is hardcoded in handleKeyPress, not registered as global hotkey
 
-	// Hint mode with actions hotkey
-	if key := strings.TrimSpace(a.config.Hotkeys.ActivateHintModeWithActions); key != "" {
-		a.logger.Info("Registering hint mode with actions hotkey", zap.String("key", key))
-		if _, err := a.hotkeyManager.Register(key, func() {
-			a.activateHintMode(true)
-		}); err != nil {
-			return fmt.Errorf("failed to register hint mode with actions hotkey: %w", err)
+	// Register arbitrary bindings from config.Hotkeys.Bindings
+	// We intentionally don't fail the entire registration process if one binding fails;
+	// instead we log the error and continue so the daemon remains running.
+	for k, v := range a.config.Hotkeys.Bindings {
+		key := strings.TrimSpace(k)
+		action := strings.TrimSpace(v)
+		if key == "" || action == "" {
+			continue
 		}
-	}
 
-	// Scroll mode hotkey
-	if key := strings.TrimSpace(a.config.Hotkeys.ActivateScrollMode); key != "" {
-		a.logger.Info("Registering scroll mode hotkey", zap.String("key", key))
-		if _, err := a.hotkeyManager.Register(key, a.activateScrollMode); err != nil {
-			return fmt.Errorf("failed to register scroll mode hotkey: %w", err)
+		a.logger.Info("Registering hotkey binding", zap.String("key", key), zap.String("action", action))
+
+		// Capture values for closure
+		bindKey := key
+		bindAction := action
+
+		if _, err := a.hotkeyManager.Register(bindKey, func() {
+			// Run handler in separate goroutine so the hotkey callback returns quickly.
+			go func() {
+				defer func() {
+					if r := recover(); r != nil {
+						a.logger.Error("panic in hotkey handler", zap.Any("recover", r), zap.String("key", bindKey))
+					}
+				}()
+
+				// Exec mode: run arbitrary bash command
+				if strings.HasPrefix(bindAction, "exec ") {
+					cmdStr := strings.TrimSpace(strings.TrimPrefix(bindAction, "exec"))
+					if cmdStr == "" {
+						a.logger.Error("hotkey exec has empty command", zap.String("key", bindKey))
+						return
+					}
+
+					a.logger.Debug("Executing shell command from hotkey", zap.String("key", bindKey), zap.String("cmd", cmdStr))
+					cmd := exec.Command("/bin/bash", "-lc", cmdStr)
+					out, err := cmd.CombinedOutput()
+					if err != nil {
+						a.logger.Error("hotkey exec failed", zap.String("key", bindKey), zap.String("cmd", cmdStr), zap.ByteString("output", out), zap.Error(err))
+					} else {
+						a.logger.Info("hotkey exec completed", zap.String("key", bindKey), zap.String("cmd", cmdStr), zap.ByteString("output", out))
+					}
+					return
+				}
+
+				// Otherwise treat the action as an internal neru command and dispatch it
+				resp := a.handleIPCCommand(ipc.Command{Action: bindAction})
+				if !resp.Success {
+					a.logger.Error("hotkey action failed", zap.String("key", bindKey), zap.String("action", bindAction), zap.String("message", resp.Message))
+				} else {
+					a.logger.Info("hotkey action executed", zap.String("key", bindKey), zap.String("action", bindAction))
+				}
+			}()
+		}); err != nil {
+			a.logger.Error("Failed to register hotkey binding", zap.String("key", key), zap.String("action", action), zap.Error(err))
+			// continue registering other bindings
+			continue
 		}
 	}
 
-	// Note: Escape key for exiting modes is hardcoded in handleKeyPress, not registered as global hotkey
 	return nil
 }
 

configs/default-config.toml

@@ -129,23 +129,16 @@ additional_firefox_bundles = []
 
 [hotkeys]
 # all hotkeys can be disabled by either setting the key to "" or just commenting it out
+"Cmd+Shift+Space" = "hints" # Same as running `neru hints` in the terminal
+"Cmd+Shift+A" = "hints_action" # Same as running `neru hints_action` in the terminal
+"Cmd+Shift+J" = "scroll" # Same as running `neru scroll` in the terminal
 
-# Activate hint mode (direct click)
-activate_hint_mode = "Cmd+Shift+Space"
-
-# Activate hint mode with action selection (choose click type after typing hint)
-activate_hint_mode_with_actions = "Cmd+Shift+A"
-
-# Activate scroll mode for vim-style scrolling
-activate_scroll_mode = "Cmd+Shift+J"
+# To run a shell command from a hotkey, prefix the value with `exec `:
+# "Ctrl+Alt+T" = "exec open -a Terminal"
+# "Ctrl+Alt+F" = "exec osascript -e 'display notification \"This is a test notification!\" with title \"Hello from Terminal\" subtitle \"Just testing 🚀\"'"
 
 # Note: Escape key is hardcoded to exit any active mode
 
-# Hotkey format notes:
-# - Use `Cmd`, `Ctrl`, `Alt`, `Shift`, or `Option` as modifiers.
-# - Keys can be letters, function keys, or names like `Space`.
-# - Set any hotkey to "" to disable that action.
-
 [hints]
 # Characters used to build hint labels for alphabet style.
 # - At least 2 characters; choose distinct, easy-to-type ones.

internal/bridge/eventtap.h

@@ -14,6 +14,6 @@ EventTap createEventTap(EventTapCallback callback, void* userData);
 void enableEventTap(EventTap tap);
 void disableEventTap(EventTap tap);
 void destroyEventTap(EventTap tap);
-void setEventTapHotkeys(EventTap tap, const char* hintModeHotkey, const char* hintModeWithActionsHotkey, const char* scrollModeHotkey);
+void setEventTapHotkeys(EventTap tap, const char** hotkeys, int count);
 
 #endif // EVENTTAP_H