CLAUDE.md examples from real projects

How real projects brief Claude Code: the commands, conventions and warnings they put in CLAUDE.md.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Worked for most · soon

maister-dev

maister-devReads credentialsCLAUDE.md

maister

maister-dev/maister/CLAUDE.md

MAIster is the self-hosted execution and governance layer for reproducible AI-powered SDLC processes over private code. What it does, the challenges it answers, and the core functions are the canonical short description in README (section "What MAIster does"). The product spine, principles, and validation goal live in docs/VISION.md; the detailed product model and JTBD in docs/PRODUCT_VIEW.md. What follows here is the agent-facing operating contract — locked decisions and current scope. Audience: a technical owner or small engineering team operating multiple…

106mo agoReviewMount

maister-devCLAUDE.md

maister

maister-dev/maister/docs/CLAUDE.md

Read ../CLAUDE.md first for the product spine, locked decisions, and current scope labels. This file is the contract for how to maintain the docs/ folder — what lives where, in what format, and which rules apply when editing. docs/ is the canonical knowledge base for MAIster. It answers four questions a human or agent should never have to dig through code for: When code and docs disagree, the source code wins (code is executable truth). The fix is to update…

106mo agoReviewMount

maister-devCLAUDE.md

maister / web

maister-dev/maister/web/CLAUDE.md

Read ../CLAUDE.md first. It holds the product spine, locked architectural decisions (ACP-driven HITL + checkpoint/resume, durable canonical SSE, typed MaisterError, concurrency cap, multi-executor via ACP, Flow Engine v2 plugin model) and the out-of-POC list. This file is the Web/Next.js slice only. Agent processes live in ../supervisor/, NOT here. This is the web tier of MAIster: UI + Route Handlers + server actions + Drizzle DB access + SSE bridge to supervisor/. Agent processes (claude, codex) and ACP sessions live in…

106mo agoReviewMount

CLAUDE.md vs AGENTS.md

About CLAUDE.md

What is CLAUDE.md?

A file Claude Code reads at the start of every session. It holds the commands, conventions and warnings the agent needs for this project.

Where does it go?

At the repository root. Claude Code also reads CLAUDE.md files in subdirectories when it works there.

What should it contain?

Build and test commands, the project's layout, conventions that aren't obvious from the code, and mistakes to avoid. Short files tend to work better than long ones.

CLAUDE.md or AGENTS.md?

Claude Code reads CLAUDE.md; most other agents read AGENTS.md. Many projects keep one and point the other at it.