localOCR AGENTS.md

localOCR AGENTS.md is an instructions file for Codex, OpenCode from Curiosity-Ai-BV/localOCR. It costs 574 tokens per session, scanned A, original, MIT.

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.

In plain words
What is it for?
Finding the main application modules, creating the Python environment, running the Streamlit interface or command-line processor, and running pytest tests.
Why use it?
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.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/curiosity-ai-bv/localocr/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.

agentmods badge for localOCR AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/curiosity-ai-bv/localocr/agents-md.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.svg" alt="Measured on agentmods" 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. Scan, not verified.
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.

ModelPer sessionOnce invoked
Fable 5.1 $0.00574 $0.00574
Opus 5 $0.00287 $0.00287
Sonnet 5 $0.00115 $0.00115
Haiku 4.5 $0.00057 $0.00057

Measured today against content hash 7b9bc3d0cf4e, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-05, 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 today.

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.

  1. today 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 3mo ago), licensed MIT. It adds 574 tokens to every session, about $0.0029 per session on Opus 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.