nutjs.dev
nut.js v3.0.0 is here! 🎉
Read the announcement blog post here!
Open Source Node.js Cross Platform Desktop Automation
🚀 Let's get started!Automate mouse movement
nut.js gives you full control over your mouse. Move, click or drag your cursor where you need it!
Automate keyboard input
Press (and hold) single keys or type pages of text, nut.js handles both!
Copy & Paste
nut.js gives you access to your system clipboard. Copy and paste text as you go!
Window Info
Retrieve infos about open windows to improve your tests or workflows
Visual automation & testing
nut.js provides plug-ins to perform on-screen search for images and/or text, the key component for visual testing or automation!
Cross-platform
nut.js works on all major operating systems. Windows, macOS and Linux!
Sponsoring
Sustainable open source software
- 1
Start sponsoring
Either via GitHub Sponsors or Patreon
- 2
Get in touch
Reach out to kontakt@s1h.org with your npm user account and the sponsoring confirmation
- 3
Get access
Once I reviewed your data I'll send you an invite to private packages
Individual
Everything in Free
Private package access for one user
- @nut-tree/bolt package
- @nut-tree/nl-matcher package
- @nut-tree/plugin-ocr package
Company
Everything in Individual
Private package access for up to three users
Prioritized issues
nut.js is an open source project, so development and maintenance happens in my free time.
Sponsoring development will give you access to private packages and ensures continuous maintenance.
Additionally, it allows me to pay for hardware to support additional platforms/architectures or features! The ultimate goal would be to work full-time on nut.js.
Conclusion: If nut.js is beneficial for you or your company, you should consider sponsoring the project!
No! You don't have to sponsor me to use nut.js (although I'd be really greatful if you'd do it anyways).
I'm providing optional, ready-to-use plugins for sponsors, but you could also build your own by implementing one of the available plugin interfaces.
At the moment private packages include:
- An improved image matching plugin that supports Apple Silicon chips, works across all current and future node/Electron versions and provides multi-image matching
- An OCR plugin which implements the `TextFinderInterface` to perform on-screen text search
- An OCR add-on to perform on-screen text extraction via OCR
- An improved low-level provider package that provides e.g. unicode support for keyboard input
Yes! If you are stuck with something and want me to help you out, feel free to reach out to me at kontakt@s1h.org
No, sorry! I'm already providing nut.js for free, which takes up quite a lot of my time.
If you want me to help you fix a problem, please refer to #4.
© 2023