rtfm.status

A command that reports the status and health of an RTFM project index. The index is a searchable record of books and other source files, including their text chunks and search-embedding coverage.

In plain words
What is it for?
Use it to check books, chunks, corpora, embeddings, last-sync time, registered parsers, pending file changes, missing files, scan warnings, and OCR progress.
Why use it?
It shows whether files are new, changed, missing, or waiting to be indexed, and whether scanned PDFs may need OCR, which turns image-only pages into searchable text. It also reports indexing progress when an OCR process is running.

Command

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 commands/roomi-fields/rtfm/rtfm.status
Clone the repo
git clone --depth 1 https://github.com/roomi-fields/rtfm
Per session 16 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 385 The whole file, excluding the scripts and references it only reads on demand.
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 $0.00016 $0.00385
Opus 5 $0.00008 $0.00192
Sonnet 5 $0.00003 $0.00077
Haiku 4.5 $0.00002 $0.00038

Measured 2d ago against content hash a01b244a9476, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

rtfm.status 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 2d 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.

commands/rtfm.status.md · 32 lines

What it actually says

The user wants the current RTFM indexing status for this project.

Run rtfm status --health using the Bash tool. The --health flag adds pending-sync counts on top of the default output:

  • Books / chunks / corpora / embedding coverage
  • Date of the last sync
  • Registered parsers and optional extras (pdf, embeddings, ...)
  • Index health:
    • + N new file(s) not yet indexed (run rtfm sync)
    • ~ N modified file(s) since last sync (run rtfm sync)
    • - N file(s) in DB but missing on disk (run rtfm sync)
    • ⚠ N PDF(s) flagged as likely scans (run /rtfm.ocr or rtfm sync --ocr)

Note: --health walks every configured source and stat()s every tracked file. On corpora that live on NTFS-via-WSL or network shares, this can take tens of seconds per source — it's normal, just let it run.

If an OCR daemon section appears in the output (e.g. OCR running (PID X): 23/156 PDFs (15%), 1h20m elapsed, ETA ~6h), highlight it first — that's the most time-sensitive signal for the user.

After it completes, summarize the key signals:

  • Is an OCR daemon currently running, and where is it in its progress? (If OCR interrupted at K/N, suggest rtfm sync --ocr to resume.)
  • Is the index up to date or are there pending files?
  • Are there scan suspects waiting for OCR?
  • Anything that requires user action?
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. 2d ago First seen · 32 lines · 16 tokens per session scan A a01b244a9476

Subscribe to this mod's changes

rtfm.status is a command published in the GitHub repository roomi-fields/rtfm (24 stars, last pushed 2d ago), licensed MIT. It adds 16 tokens to every session and 385 once invoked, about $0.0001 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-08-30.