CLAUDE.md generator
Generate a production-ready CLAUDE.md for your project in 30 seconds. Pick your framework, choose your stack options, copy and drop the file into your repo root.
What is CLAUDE.md and why does it matter?
CLAUDE.md is a project context file read by Claude Code at the start of every session. It tells Claude your stack, conventions, commands, and constraints — so you stop re-explaining them in every chat. A good CLAUDE.md cuts prompt overhead by 30–50% and dramatically improves Claude's first-attempt accuracy on your codebase.
Place it at your repo root. Claude Code reads it automatically. The file uses Markdown and supports any instructions: which files to avoid editing, which patterns to always follow, which dependencies to prefer, and what the project actually does. Think of it as onboarding documentation written specifically for your AI pair programmer.
Frequently asked questions
What should a CLAUDE.md file include?
A CLAUDE.md should include: your tech stack and versions, the commands to run for dev/build/test/lint, the project folder structure, code style conventions (naming, exports, file organisation), which files or patterns to avoid modifying, environment variable requirements, and a brief project description. The goal is that any senior developer — or Claude — could orient to your codebase in under 5 minutes.
How long should a CLAUDE.md be?
Keep it between 100 and 400 lines. Too short and Claude lacks context; too long and you waste tokens on every session. Focus on information that Claude cannot infer from reading the code — your team's specific conventions, deployment quirks, which libraries you've standardised on, and explicit "do not do X" rules. Avoid reiterating things Claude already knows about Next.js or React best practices unless your project deviates from them.
Does CLAUDE.md actually improve Claude Code output?
Yes, significantly. Without CLAUDE.md, Claude guesses your conventions from filenames and imports — it might use default exports when you prefer named exports, or write JavaScript when you want TypeScript. With a well-written CLAUDE.md, Claude Code follows your patterns from the first message. It also prevents common mistakes like importing Prisma directly instead of using your singleton, or writing fetch() calls instead of using your API layer.
Where do I put the CLAUDE.md file?
Place CLAUDE.md at the root of your repository — the same directory as your package.json or pyproject.toml. Claude Code reads it automatically when you open a project. You can also place additional CLAUDE.md files in subdirectories for monorepos; Claude reads them when working in those directories. Commit it to version control so every developer on your team benefits from it, not just you.