node-keylogger

Cross-platform Node.js keylogger using events.

Features

• Cross-platform support (Linux, Windows, macOS)
• No external dependencies
• Event-based API
• TypeScript-friendly
• Clean and modular codebase

Installation

npm install node-keylogger

Usage

const Keyboard = require('node-keylogger');

// Create a new keyboard instance
const keyboard = new Keyboard(); // Device parameter only needed for Linux

// Listen for key events
keyboard.on('keydown', console.log);
keyboard.on('keyup', console.log);
keyboard.on('keypress', console.log);
keyboard.on('error', console.error);

Implementation Process

1. Initial Setup

   npm install node-keylogger

2. Basic Implementation

   const Keyboard = require('node-keylogger');
   
   // Initialize keyboard
   const keyboard = new Keyboard();
   
   // Handle keyboard events
   keyboard.on('keypress', (event) => {
     console.log(`Key pressed: ${event.keyId}`);
   });

3. Error Handling

   keyboard.on('error', (error) => {
     console.error('Keyboard Error:', error);
     // Implement your error handling logic
   });

4. Cleanup

   // Important: Always close the keyboard listener
   process.on('SIGINT', () => {
     keyboard.close();
     process.exit();
   });

5. Platform-Specific Setup

   • Linux: Ensure read permissions for /dev/input/

   sudo chmod a+r /dev/input/event*

   • Windows: Run with administrative privileges
   • macOS: Grant accessibility permissions in System Preferences

Event Object Structure

{ 
  timeS: 1347572085,    // Timestamp (Seconds part)
  timeMS: 741381,       // Timestamp (Microseconds part)
  keyCode: 17,          // Keyboard code
  keyId: 'KEY_W',       // Key ID
  type: 'keypress',     // Event type
  dev: 'event0'         // Device (Linux) or platform name
}

Platform-Specific Notes

Linux

• Requires read access to /dev/input/ devices
• Specify the keyboard device (e.g., 'event0')

Windows

• Uses PowerShell and Windows Forms for key monitoring
• Requires PowerShell

macOS

• Uses Swift and Cocoa for key monitoring
• Requires XCode Command Line Tools

Security Note

This module requires system-level access to monitor keyboard events. Make sure you have the necessary permissions and understand the security implications of keyboard logging.

License

MIT