winocr

Crates.iowinocr
lib.rswinocr
version0.1.1
created_at2025-08-02 05:54:09.628778+00
updated_at2025-08-04 00:36:56.041904+00
descriptionAn OCR Tool using Windows.Media.Ocr.OcrEngine API.
homepage
repositoryhttps://github.com/riddleling/winocr
max_upload_size
id1778315
size54,683
Ling, Wei-Cheng (riddleling)

documentation

README

winocr

An OCR Tool using Windows.Media.Ocr.OcrEngine API

Command Line Arguments

An OCR Tool using Windows.Media.Ocr.OcrEngine API.

Usage: winocr.exe [OPTIONS] [FILES]...

Arguments:
  [FILES]...  Input files

Options:
  -o, --ocr          OCR and export text files
  -s, --server       Run HTTP Server
  -a, --auth <AUTH>  HTTP Basic Auth (username:password) [default: ]
  -p, --port <PORT>  HTTP port number [default: 8000]
  -h, --help         Print help
  -V, --version      Print version

How to use

Read images and perform OCR, then output the result to text files

winocr -o *.png

Start the OCR HTTP server and specify the HTTP port

winocr -s -p 8080

Start the OCR HTTP server and configure HTTP Basic Auth

winocr -s -a admin:password123 -p 8080

After starting the HTTP server, you can upload an image from the homepage HTML or use curl to send an image via the upload API

curl -u admin:password123 -H "Accept: application/json" -X POST http://localhost:8080/upload -F "file=@01.png"

Installation

Download binary

Goto Download

Install by cargo

cargo install winocr
winocr -h

Features

  • Directly call the Windows.Media.Ocr.OcrEngine API for OCR

  • Command-line mode: allows batch processing of image files and exports OCR results as TXT files

  • HTTP server mode: provides a web interface to upload images and return OCR results

  • Supports both HTML form upload and API interfaces

  • Configurable HTTP Basic Auth authentication

  • The maximum upload image size is 100 MB

Use cases

  • Windows users need to perform batch OCR processing

  • Applications that need to integrate OCR functionality via API

License

MIT License

Commit count: 0

cargo fmt