What is omabook CLAUDE.md?

A project-specific instruction file for omabook, a C++ and Qt 6 book reader supporting EPUB, PDF, and MOBI files, with reading aloud and local AI features.

Use it when setting up omabook, changing its layout or C++ code, building with Qt, or comparing behavior with the reference implementation.

It explains how to build, test, and maintain the ongoing rewrite while preserving behavior from the original Rust version.

How newx/omabook configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to newx/omabook. 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/newx/omabook/main/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/newx/omabook

Made for: Claude Code.

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/newx/omabook/claude-md/github.svg)](https://agentmods.dev/instructions/newx/omabook/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/newx/omabook/claude-md"><img src="https://agentmods.dev/badge/instructions/newx/omabook/claude-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/newx/omabook/claude-md"><img src="https://agentmods.dev/badge/instructions/newx/omabook/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 6,925 This file is loaded in full into every session.

When invoked 6,925 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.06925	$0.06925
Opus 5.5	$0.02770	$0.02770
Sonnet 5.5	$0.01385	$0.01385
Haiku 4.5	$0.00692	$0.00692

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

Security

Grade A, and why

omabook CLAUDE.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.

CLAUDE.md · 585 lines

How it starts

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

CLAUDE.md

Orientation for coding agents working in this repository. Humans want the README; this file covers setup and the conventions that are not obvious from the code.

What this is. omabook is a book library and reader for Omarchy — EPUB, PDF and MOBI, with reading aloud and local AI. It is plain C++17 and Qt 6, built the same way as omawrite, the Omarchy Markdown editor. SPEC.md is the reference for intent and TODO.md tracks what is left.

omawrite is the style authority. When this document and omawrite disagree, omawrite wins and this document is wrong. There are exactly three deliberate divergences, all because omabook is roughly ten times omawrite's size; each is named and justified where it appears rather than left to be discovered.

Setup

One thing is needed before a clone will run, and one thing used to be.

1. Qt 6. qt6-base, qt6-declarative, qt6-webengine, qt6-webchannel, qt6-imageformats, qt6-svg, plus poppler for PDF covers and text. Arch ships qmake as qmake6; bin/build resolves either name.

qt6-imageformats is not optional and is easy to miss: without it, WebP covers — which some EPUBs use — decode to nothing and the book gets no cover, with no error anywhere.

2. Nothing else. The reader engine, foliate-js, is vendored in assets/reader/foliate-js, so a clone is complete and a release tarball is a buildable reader. It is a verbatim copy of one upstream commit, recorded in assets/reader/foliate-js.version, and it is never edited in place: everything omabook adds on top of foliate lives outside the tree — the fixed-layout overlay in reader.html, js-polyfills.js, pdf-worker-shim.mjs — so that an update stays a replacement rather than a merge. Update it with one command, and review what it leaves behind as upstream's diff and nothing else:

./bin/vendor-foliate-js          # whatever main points at today
./bin/vendor-foliate-js <commit> # or a specific one

Read the full file on GitHub · 585 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 Changed · +4 lines · -4 tokens per session 831a27bac764
2mo ago First seen · 581 lines · 6,929 tokens per session scan A 51147433e4b1

Subscribe to this mod's changes

omabook CLAUDE.md is an instructions file published in the GitHub repository newx/omabook (15 stars, last pushed 2mo ago), licensed MIT. It adds 6,925 tokens to every session, about $0.0277 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-08-31.

omabook CLAUDE.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
omabook CLAUDE.mdnewx/omabook	Instructions file	15	2mo ago	MIT	A	6,925	Claude Code
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	5,685	GitHub Copilot
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	3,093	GitHub Copilot
vscode model-prompts.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	2,022	GitHub Copilot

omabook: Instructions file for Claude Code