nut.js logonut.js
  • Docs
  • Plugins
  • Examples
  • Pricing
  • Blog
  • Changelog
  • Getting Started
  • Installation
  • Configuration
  • Mouse Control
  • Keyboard Input
  • Screen
  • Window Management
  • Clipboard
  • Image Search
  • Text Search (OCR)
  • Element Search
  • Color Search
  • Migration Guides
  • Browse API Docs
  1. Home
  2. Documentation
  3. API Reference
  4. Plugin-ocr
  5. V4.0.0
  6. Nut-tree-plugin-ocr
Version:
API/plugin-ocr/@nut-tree/plugin-ocr

plugin-ocr

@nut-tree/plugin-ocr

Interfaces

interface

OcrPluginConfiguration

Configuration options for the OCR plugin.

interface

ReadTextConfig

Configuration options for screen.read().

interface

TextFinderConfig

Configuration options for text search via screen.find().
Pass as providerData in the find options.

Functions

function

configure

function

preloadLanguages

function

useOcrPlugin

Enums

enum

Language

enum

LanguageModelType

Tesseract language model type, trading off speed vs. accuracy.

enum

TextSplit

Controls the granularity at which OCR results are split when using screen.read().

Was this page helpful?

nut.js logonut.js
DocumentationGitHubBlogSystem Status

Made with ❤️ for automation

© 2026 nutjs.dev. All rights reserved.

ImprintPrivacy PolicyEULACancellation Policy