CLAUDE.md examples from real projects

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

Best matchesWorked for most · soon

garrytanCLAUDE.md

gstack

garrytan/gstack/CLAUDE.md

with the Aside app open and self-skips elsewhere (`asideAvailable()`). make-pdf's render gates and `test/skill-e2e-diagram.test.ts` run through whichever engine resolves (`browserAvailable()` — Aside, or the browse binary CI builds

134k6d agoReads credentialsDiscuss

browser-useCLAUDE.md

browser-use

browser-use/browser-use/CLAUDE.md

Browser Management BrowserSession uses a `bubus` event bus to coordinate watchdog services: - **DownloadsWatchdog**: Handles PDF auto-download and file management - **PopupsWatchdog**: Manages JavaScript dialogs and popups - **SecurityWatchdog**: Enforces domain restrictions

117k4mo agoDiscuss

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.