aaronjmarsReads credentialsCLAUDE.mdMiroShark
aaronjmars/MiroShark/CLAUDE.md
Guidance for AI coding agents (Claude Code and similar) working in this repo. Human-facing docs live in README.md and docs/ — this file is the agent's map: how the code…
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
aaronjmarsReads credentialsCLAUDE.mdAbout 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.