← Back to Library|PromptsWrite a CLAUDE.md for Your Project

Write a CLAUDE.md for Your Project

Generate a project context file that AI coding agents read automatically, so every interaction starts with full awareness of your codebase.

5-10 min|Beginner
BuildQuick WinDeveloper
Prompt Template
Create a CLAUDE.md file for my project. Here's what you need to know:

- Framework: [e.g. Next.js 15, App Router]
- Language: [e.g. TypeScript strict]
- Styling: [e.g. Tailwind CSS v4, shadcn/ui]
- Database: [e.g. PostgreSQL with Drizzle ORM]
- Auth: [e.g. Supabase Auth]
- Hosting: [e.g. Vercel]
- Key conventions: [e.g. route groups (marketing)/(app), server components by default, font-heading for headings]
- What NOT to do: [e.g. never use class components, never add comments to obvious code]

Structure it with these sections: Project Overview, Tech Stack, Key Routes, Conventions, What NOT to do. Keep it under 200 lines. Use bullet points, not paragraphs."

**Output format:** A markdown file ready to save as CLAUDE.md in the project root.

The AI agent reads this file before every task, so it never asks you to repeat your stack choices or conventions. One-time investment, permanent payoff.

At the start of any project. Update it whenever you add a major dependency or change a convention.

Write a CLAUDE.md for Your Project | Library | Modern Vibe Coding