Node-enigo NPM

node-enigo

A Node.js binding for the Rust enigo library, providing cross-platform keyboard and mouse automation.

Installation

npm install node-enigo

Usage

const enigo = require('node-enigo');

// Type text (Promise-based, non-blocking)
await enigo.typeText('Hello, world!');

// Or with Promise syntax
enigo.typeText('Hello, world!')
  .then(result => console.log(result))
  .catch(error => console.error(error));

API

`typeText(text: string): Promise<string>`

Types the specified text at the current cursor position. Returns a Promise that resolves with the result.

Parameters:

text (string): The text to type

Returns:

A Promise that resolves to a string with the result of the operation

Example with async/await:

const enigo = require('node-enigo');

async function example() {
  try {
    // Type text with await
    const result = await enigo.typeText('Hello, world!');
    console.log(result);
  } catch (error) {
    console.error('Error:', error);
  }
}

example();

Example with Promises:

const enigo = require('node-enigo');

// Type text with Promise syntax
enigo.typeText('Hello, world!')
  .then(result => console.log(result))
  .catch(error => console.error('Error:', error));

Supported Platforms

macOS: x64, arm64
Windows: x64, ia32
Linux: x64, arm64

Permissions

macOS

On macOS, you need to grant accessibility permissions to the application running this code:

Go to System Preferences > Security & Privacy > Privacy > Accessibility
Click the lock icon to make changes (you'll need to enter your password)
Add your application to the list
Make sure the checkbox next to the application is checked

Without these permissions, the keyboard and mouse automation will not work.

Windows

On Windows, the application respects the user's scaling settings.

Linux

On Linux, make sure X11 permissions are set correctly.

Examples

See the example.js and non-blocking-example.js files for usage examples.

Building from Source

If you want to build the library from source:

git clone https://github.com/yourusername/node-enigo.git
cd node-enigo
npm install
npm run build

Building and Distributing Binaries

This project uses GitHub Actions to automatically build and distribute binaries for multiple platforms and architectures.

Supported Platforms in CI

Linux: x64
macOS: arm64

How to Release

Create a new tag with the version number:
```
git tag v1.2.0
git push origin v1.2.0
```
The GitHub Actions workflow will automatically:
- Build binaries for all supported platforms
- Create a GitHub Release with the binaries attached
- The binaries will be named according to their platform and architecture:
  - node-enigo-linux-x64.node
  - node-enigo-macos-arm64.node