What is localOCR AGENTS.md?

Repository instructions for localOCR, a Python application that extracts information from documents and images. They describe its files, setup commands, coding conventions, and automated test commands.

Finding the main application modules, creating the Python environment, running the Streamlit interface or command-line processor, and running pytest tests.

They give contributors the project-specific information needed to change the code without guessing how it is structured or tested. They also standardize how the application and its checks are run.

How Curiosity-Ai-BV/localOCR configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to Curiosity-Ai-BV/localOCR. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/Curiosity-Ai-BV/localOCR/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/Curiosity-Ai-BV/localOCR

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/curiosity-ai-bv/localocr/agents-md/github.svg)](https://agentmods.dev/instructions/curiosity-ai-bv/localocr/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/curiosity-ai-bv/localocr/agents-md"><img src="https://agentmods.dev/badge/instructions/curiosity-ai-bv/localocr/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/curiosity-ai-bv/localocr/agents-md"><img src="https://agentmods.dev/badge/instructions/curiosity-ai-bv/localocr/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 574 This file is loaded in full into every session.

When invoked 574 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00574	$0.00574
Opus 5.5	$0.00230	$0.00230
Sonnet 5.5	$0.00115	$0.00115
Haiku 4.5	$0.00057	$0.00057

Measured 2mo ago against content hash 7b9bc3d0cf4e, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

localOCR AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 29 lines

How it starts

The opening of the file, as written. The whole thing — 29 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Repository Guidelines

Project Structure & Module Organization

Application entry points live in app.py (Streamlit UI) and cli.py (headless runs). Processing primitives sit under core/ (pipeline.py, json_extract.py, image_utils.py, templates.py) with model bindings in adapters/ollama_adapter.py. UI helpers reside in ui/export.py, shared typings in utils/typing.py, and reusable assets in assets/. Test data and reference documents live in samples/, while automated tests live in tests/.

Build, Test, and Development Commands

Create a virtual environment and install runtime deps:

python -m venv venv && source venv/bin/activate
pip install -r requirements.txt

Install tooling for contribution work:

pip install -r requirements-dev.txt

Run the Streamlit app locally with streamlit run app.py. Start the CLI batch processor via python cli.py --help to explore available flags — prime examples include --pdf-pages to fan out multi-page PDFs and --pdf-scale for render DPI. Execute automated tests using pytest.

Coding Style & Naming Conventions

Follow PEP 8 with four-space indentation and keep functions small and composable, mirroring the current module layout. Use descriptive, snake_case names for functions and variables; reserve PascalCase for classes and TypedDicts. Maintain type hints and docstrings where already present, and prefer helper functions within core/ over duplicating logic in app.py. When formatting sizable changes, run ruff format or black if already configured in your environment; otherwise stay consistent with existing whitespace.

Testing Guidelines

Place new unit tests in tests/, mirroring the module under test (test_json_extract.py, test_pdf_convert.py provide patterns). Name tests with test_<feature> for pytest discovery. Ensure new OCR or extraction behaviors include assertions for both success paths and failure handling. Run pytest -q before submitting; target full pass on macOS with Ollama available, and guard tests so they gracefully skip when optional services are missing.

Read the full file on GitHub · 29 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2mo ago First seen · 29 lines · 574 tokens per session scan A 7b9bc3d0cf4e

Subscribe to this mod's changes

localOCR AGENTS.md is an instructions file published in the GitHub repository Curiosity-Ai-BV/localOCR (148 stars, last pushed 5mo ago), licensed MIT. It adds 574 tokens to every session, about $0.0023 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-04.

Documents Languages Python

localOCR AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
localOCR AGENTS.mdCuriosity-Ai-BV/localOCR	Instructions file	148	5mo ago	MIT	A	574	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	today	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

localOCR: Instructions file for Codex