What is family-book CLAUDE.md?

Development instructions for Family Book, a private website for storing family trees and family archives on your own server.

Use it when developing or deploying Family Book, running its server and tests, changing the database structure, or handling backups and media.

It tells a coding agent which technologies, setup commands, database steps, and deployment process the project uses.

How tymrtn/family-book configures Claude Code

Reuse

Borrowing it

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

Clone the repo

git clone --depth 1 https://github.com/tymrtn/family-book

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

Your own site

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

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

When invoked 891 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.00891	$0.00891
Opus 5.5	$0.00356	$0.00356
Sonnet 5.5	$0.00178	$0.00178
Haiku 4.5	$0.00089	$0.00089

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

Security

Grade A, and why

family-book 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 · 93 lines

How it starts

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

CLAUDE.md — Family Book Build Guide

What This Is

Family Book is a private, self-hosted family tree and archive with sovereign data ownership. Read SPEC.md (the complete 2000+ line specification) before touching any code.

Tech Stack

Backend: Python 3.12 + FastAPI + SQLAlchemy + Alembic
Database: SQLite (WAL mode) on persistent volume at /data/family.db
Frontend: Jinja2 templates + HTMX + D3.js (tree visualization only)
Auth: Session cookies (HttpOnly, Secure, SameSite=Lax)
Media: Stored at /data/media/, served through authenticated endpoint

Local Development

# Setup
cp .env.example .env  # Edit with your values
uv sync
uv run alembic upgrade head
uv run python -m app.seed  # Optional: load seed data

# Run
uv run uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload

# Test
uv run pytest

Database Migrations

uv run alembic revision --autogenerate -m "description"
uv run alembic upgrade head
uv run alembic downgrade -1  # Rollback

Deploy (Railway)

railway up

Railway runs the Dockerfile. Persistent volume at /data. Health check at /health.

Backup / Restore

# Backup (also runs daily via cron)
sqlite3 /data/family.db ".backup /data/backups/family-$(date +%Y%m%d).db"
gzip /data/backups/family-*.db

# Restore
cp backup.db /data/family.db
uv run alembic upgrade head

Restore procedure MUST be tested before go-live. Record test date here: _____

Key Architecture Rules

HTMX for everything except the tree. D3.js is used ONLY for the tree visualization. Everything else is server-rendered HTML + HTMX.
No SPA frameworks. No React, Vue, or Angular. Vanilla JS + HTMX + D3.
All media served through authenticated endpoints. Never serve media as static files. Always check session auth.
Root person redaction. The Person with is_root=true has their name redacted in ALL API responses and templates. Use display_name (computed server-side), never raw first_name/last_name.
Source tracking. Every Person, ParentChild, Partnership, Media, and Moment has a source field. Always set it correctly.
Dedup by hash. All media imports must check SHA-256 file hash before creating records.
Audit everything. All mutations to Person, ParentChild, Partnership create AuditLog entries.

Read the full file on GitHub · 93 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 · 93 lines · 891 tokens per session scan A 5183a1c6c2db

Subscribe to this mod's changes

family-book CLAUDE.md is an instructions file published in the GitHub repository tymrtn/family-book (23 stars, last pushed 7d ago), licensed MIT. It adds 891 tokens to every session, about $0.0036 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-30.

family family-tree fastapi genealogy htmx imessage

family-book CLAUDE.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
family-book CLAUDE.mdtymrtn/family-book	Instructions file	23	7d ago	MIT	A	891	Claude Code
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	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

family-book: Instructions file for Claude Code