nut.js in a nutshell

Learn what nut.js is capable of and how to get started.

Quick start

Here's a five step quick start guide to get you started with nut.js.

1. Create a new npm project

   mkdir my-new-project
   cd my-new-project
   npm init
   

2. Install nut.js

   npm i @nut-tree/nut-js
   

3. Create a new file index.js and add the following code

   const { mouse, left, right, up, down } = require('@nut-tree/nut-js');
   
   (async () => {
     await mouse.move(right(500));
     await mouse.move(down(500));
     await mouse.move(left(500));
     await mouse.move(up(500));
   })();
   

4. Run your script

   node index.js
   

5. Enjoy your first nut.js script by watching your mouse move in a square