Skip to content

CheckBoxOCR is a CLI tool for detecting and classifying checkboxes in PDFs and images. Packaged for secure use and easy integration into automation workflows and document pipelines.

Notifications You must be signed in to change notification settings

DevSTheDeveloper/CheckBoxOCR

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 

Repository files navigation

CheckBoxOCR

A CLI tool to detect checked and unchecked checkboxes from PDFs and images.

Screenshot 2025-07-08 at 20 28 55

This model is optimised (and mainly trained on) computer generated checkboxes. It may struggle with handwritten ones. This will be improved in a future update.


How to use

Run the executable from the CheckBoxOCR folder with your file as an argument:

./CheckBoxOCR/ocr yourfile.pdf

On Windows:

CheckBoxOCR\ocr.exe yourfile.pdf

Supported input file types:

  • Documents (.pdf)
  • Images (.png, .jpg, .jpeg, .bmp)

Output

  • Annotated images with detected checkboxes saved in the output/ folder (This will be automatically generated for you on first run)
  • Console output lists checkbox statuses and their positions on each page

Integration

(c.pdf is a sample pdf file to ensure the model runs)

You can integrate this tool into your own automation or pipelines by calling the binary directly. (Replace yourfile.pdf with the image or PDF you want to use) Example (shell):

./CheckBoxOCR/ocr yourfile.pdf 

Example (Python):

import subprocess
subprocess.run(["./CheckBoxOCR/ocr", "yourfile.pdf"])

This makes it easy to include checkbox detection in document processing systems or form analysis flows.


This is a packaged tool, there is no need to install any other packages.

Any Problems? Feel free to raise them via the issues tab. Improvements in the model will be released bi-monthly.

About

CheckBoxOCR is a CLI tool for detecting and classifying checkboxes in PDFs and images. Packaged for secure use and easy integration into automation workflows and document pipelines.

Resources

Stars

Watchers

Forks

Packages

No packages published