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

nathanaday Hiding risky files

nathanadayCLAUDE.md

almagest

nathanaday/almagest/CLAUDE.md

Almagest: the Go module github.com/nathanaday/almagest (binary almagest) and the agent plugin almagest in the repository's own marketplace. The Obsidian plugin lives in its own repository, obsidian-almagest (~/projects/software/obsidian-almagest), and reaches users only through Obsidian's community plugins. Read README.md and docs/guide.md first. This file holds what the code and those do not say. - The binary serves the MCP tools (internal/mcpserver), the hooks (internal/hooks), and the CLI (internal/cli). The vault, its index, and the write transaction are internal/vault; changes are internal/change. -…

127d 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.