https://github.com/aabuhijleh/keylogger.js
A simple Node.js keylogger for Windows and macOS
https://github.com/aabuhijleh/keylogger.js
electron javascript key keyboard keyhooks keylogger keypress keyup nodejs typescript
Last synced: about 1 month ago
JSON representation
A simple Node.js keylogger for Windows and macOS
- Host: GitHub
- URL: https://github.com/aabuhijleh/keylogger.js
- Owner: aabuhijleh
- License: mit
- Created: 2021-02-09T07:09:24.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-30T16:49:07.000Z (about 3 years ago)
- Last Synced: 2025-04-08T11:37:45.740Z (about 1 month ago)
- Topics: electron, javascript, key, keyboard, keyhooks, keylogger, keypress, keyup, nodejs, typescript
- Language: C++
- Homepage:
- Size: 45.9 KB
- Stars: 14
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Keylogger.js
A simple Node.js keylogger for Windows and macOS
## Prerequisites
Make sure you have [`node-gyp`](https://github.com/nodejs/node-gyp#installation) and its dependencies installed
## Install
```
$ npm install keylogger.js
```
## Usage
```ts
import keylogger from "keylogger.js";
// or
// const keylogger = require("keylogger.js");
keylogger.start((key, isKeyUp, keyCode) => {
console.log("keyboard event", key, isKeyUp, keyCode);
});
```
## Notes
The key value returned with the callback function passed to `keylogger.start` will match the browser's `KeyboardEvent.key` value as listed in [this table](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values)