CLAUDE.md Templates and Checker
Start from a template, or paste the file you have and get specific fixes.
Template
Checker
These checks are rules of thumb from this site, not Claude Code requirements. Nothing you paste leaves this tab.
What belongs in CLAUDE.md
- Commands Claude cannot guess: build, test one file, lint, run the dev server.
- Conventions that differ from the language default.
- Hard limits: files not to touch, actions that need approval.
- Pointers to deeper docs with
@pathimports.
What to leave out
- Anything obvious from the code, like the folder tree of a small repo.
- Long style guides. Link them or enforce them with a linter.
- Secrets. The file is usually committed.
CLAUDE.md is advice, not enforcement
Claude follows CLAUDE.md most of the time, but it is context, not a guard. For rules that must hold, use permissions.deny in settings.json or a PreToolUse hook. See the permissions builder and the hooks generator.
How the checker scores a file
It looks for a project overview, commands, a rules or conventions heading, and prohibition words (do not, never). It flags files over 200 lines, vague phrases like "write clean code", and strings that look like API keys.
FAQ
What is a CLAUDE.md file?
A markdown file that Claude Code reads at the start of every session. It holds project facts and rules: commands, conventions, and things Claude must not do.
Where does CLAUDE.md go?
Commonly in the project root (shared, committed) or in ~/.claude/CLAUDE.md (personal, all projects). Claude Code also reads CLAUDE.md files in parent and sub directories. Check the memory docs for the exact lookup order.
How long should CLAUDE.md be?
Short. Anthropic's guidance points at roughly 200 lines or fewer, because the whole file is loaded into context. Keep only what Claude cannot infer from the code.
How do I generate a CLAUDE.md?
Run /init inside Claude Code to draft one from your repo, then trim it. Or start from a template here and fill in your commands.
Can CLAUDE.md import other files?
Yes. Write @path/to/file in the text and Claude Code pulls that file in. Use it to keep the main file short.