nut.js llms.txt · AI Docs Browser · mdream

[llms.txt Tools](https://mdream.dev/llms-txt/nut-js/llms-txt)

# nut.js llms.txt

Browse nut.js documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools.

nutjs.dev/llms.txt

[Raw llms.txt](https://nutjs.dev/llms.txt) [Raw llms-full.txt](https://nutjs.dev/llms-full.txt)

Copy Markdown [](https://nutjs.dev/llms.txt)

llms.txt

Quick Facts

https://nutjs.dev

https://github.com/nut-tree/nut.js

What is nut.js?

Documentation

Getting Started

Installation

Configuration

Mouse Control

Keyboard Input

Screen

Window Management

Clipboard

Image Search

Text Search (OCR)

Element Search

Color Search

Playwright Bridge

Selenium Bridge

Migration Guides

API Reference

Examples

Jest Integration

Vitest Integration

Electron App Testing

Playwright Bridge Example

RDP Automation

Selenium Bridge Example

Color Search

Element Inspector

Image Matching

Legacy Application Automation

Text Search (OCR)

Blog (Recent Posts)

Requesting Permissions - Several Iterations Later

Introducing the @nut-tree/element-inspector Plugin for Windows

Release v4.5.0

I'm giving up — on open source

Automate outside the box - nut.js remote plugins

We have company!

A short summary of the nut.js plugin architecture!

Why screen capture is broken on macOS Ventura

Apple Silicon + Screen Capture = 💥

nut.js in a nutshell

Package Changelogs

@nut-tree/bolt Changelog

@nut-tree/element-inspector Changelog

@nut-tree/libnut Changelog

@nut-tree/nl-matcher Changelog

@nut-tree/nut-js Changelog

@nut-tree/playwright-bridge Changelog

@nut-tree/plugin-ai-sdk Changelog

@nut-tree/plugin-azure Changelog

@nut-tree/plugin-ocr Changelog

@nut-tree/plugin-screenrecording Changelog

@nut-tree/selenium-bridge Changelog

Premium Plugins

Additional Resources

RSS Feed

Full Content for LLMs

Privacy Policy

EULA

## What is nut.js's llms.txt?

nut.js publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what nut.js offers and where to find details.

Issues

Spec

8

Sections

54

Links

7.6 KB

Size

~2.0k

Tokens

Sections: Quick Facts · What is nut.js? · Documentation · Examples · Blog (Recent Posts) · Package Changelogs · and 2 more

## Add nut.js Docs to Your AI Assistant

Select your tool to see how to add nut.js's llms.txt as a documentation source.

Cursor

 Windsurf

 Claude Code

 ChatGPT

 Zed

 Copilot

1. 1

   Open any chat or composer panel
2. 2

   Type @Docs and select "Add new doc"
3. 3

   Paste the URL: https://nutjs.dev/llms.txt
4. 4

   Wait for the green dot (indexing complete)
5. 5

   Reference @Docs in chat when asking about nut.js

Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too.

## Spec Compliance 8 errors

## Frequently Asked Questions

Where is nut.js's llms.txt file?

nut.js publishes its llms.txt at https://nutjs.dev/llms.txt. This file provides a structured, markdown-formatted index of nut.js's documentation that AI systems can consume to understand the project's APIs, guides, and references.

How do I use nut.js's llms.txt with AI coding assistants?

Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of nut.js's documentation so it can provide better code suggestions and answers about nut.js.

What does nut.js's llms.txt contain?

nut.js's llms.txt contains 8 sections and 54 documentation links in 7.6 KB (~2.0k tokens). Key sections include Quick Facts, What is nut.js?, Documentation, Examples, Blog (Recent Posts), Package Changelogs.

How many tokens does nut.js's llms.txt use?

The concise llms.txt index is approximately 2.0k tokens (7.6 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline.

What is nut.js?

Desktop automation library for Node.js. Control mouse, keyboard, and screen across Windows, macOS, and Linux.. nut.js's llms.txt file helps AI systems understand this by providing a structured overview of its documentation, making it easier for developers to get accurate AI-assisted help when working with nut.js.

Can I generate an llms.txt for my own project?

Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator.

## Browse More llms.txt Files

[每日一荐 LeetCode Solutions: A Record of My Problem Solving Journey.( leetcode题解，记录自己的leetcode解题之路。)](https://mdream.dev/llms-txt/nut-js/llms-txt/leetcode) [Libsodium documentation](https://mdream.dev/llms-txt/nut-js/llms-txt/libsodium-documentation) [https://docs.litellm.ai/ llms.txt](https://mdream.dev/llms-txt/nut-js/llms-txt/litellm) [Onyx AI Onyx is the open-source AI platform for enterprise search, chat, and agents. It connects to all your company's data sources and lets teams find information, build custom AI agents, and deploy any LLM - self-hosted or cloud. SOC 2 Type II certified, GDPR compliant.](https://mdream.dev/llms-txt/nut-js/llms-txt/onyx) [AgentOps](https://mdream.dev/llms-txt/nut-js/llms-txt/agentops) [Medama Analytics](https://mdream.dev/llms-txt/nut-js/llms-txt/medama-analytics) [TinaCMS TinaCMS is an open-source, Git-backed headless CMS that supports Markdown, MDX, and JSON content. It offers visual editing, a flexible content model, and seamless integration with modern frameworks. Trusted by Unity, Smashing Magazine, and more.](https://mdream.dev/llms-txt/nut-js/llms-txt/tina) [iii iii (pronounced “three eye”) unifies your existing backend stack with a single engine and three primitives: Function, Trigger, and Worker.](https://mdream.dev/llms-txt/nut-js/llms-txt/iii)

[View all 99 projects ](https://mdream.dev/llms-txt/nut-js/llms-txt)

## Related Tools

[<h3>llms.txt Generator</h3>Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/nut-js/tools/llms-txt/generator) [<h3>llms.txt Validator</h3>Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/nut-js/tools/llms-txt/validator)

© 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license)

[GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)