CLAUDE.md template
CLAUDE.md is the Markdown file Claude Code reads at the start of every session in your project, so it knows your commands, layout and rules without being told again. Copy the file below into the root of your repository and replace each section with the facts of your own project.
Updated
Files
# Acme Dashboard
A Next.js app where customers track their orders. It reads and writes a Postgres database
through Drizzle and ships as a Docker image.
## Commands
- Install: `pnpm install`
- Dev server: `pnpm dev`, then open http://localhost:3000
- All tests: `pnpm test`
- One test file: `pnpm test lib/orders.test.ts`
- Lint and types: `pnpm lint && pnpm typecheck`
- New migration: `pnpm db:generate`, then `pnpm db:migrate`
Run the tests and the type check before you call a change done.
## Project layout
- `app/`: routes and pages (App Router)
- `components/`: shared React components; `components/ui` holds the design system
- `lib/`: server code, database queries and helpers
- `db/schema.ts`: the database schema, changed only through a migration
## Code style
- TypeScript in strict mode. Use `unknown` and narrow it instead of `any`.
- Named exports only.
- Components never query the database. Server code lives in `lib/`.
- Reuse the components in `components/ui` before writing new markup.
## Workflow
- Make the smallest change that solves the task, and leave unrelated code as it is.
- Add or update a test with every change in behavior.
- Write commit messages as Conventional Commits, such as `fix(orders): handle an empty cart`.
- Ask before you add a dependency.
## Never
- Edit a migration in `db/migrations/` that is already merged.
- Commit `.env` files or print secrets in logs.Save with your agent
Connect the Sniptide MCP server once, then ask your agent to keep this template in your library. It reads the files from the JSON version of this page and saves them as a private snippet you can edit and file into a collection.
claude mcp add --transport http sniptide https://app.sniptide.com/api/mcpRead https://sniptide.com/templates/claude-md.json and save its files as a private Sniptide snippet titled "CLAUDE.md template".How Claude Code uses it
Claude Code loads CLAUDE.md from the directory you start it in, and from every directory above it, at the start of a session. A CLAUDE.md in a subdirectory loads when Claude works with files in that directory. Your personal file at ~/.claude/CLAUDE.md applies to every project on your machine.
Everything in the file takes up context in every session, so keep it to facts Claude can't work out from the code. Running /init in Claude Code writes a first draft from your repository, which you can then trim against this template.
What each section does
Section | What to put there | When to change it |
|---|---|---|
Overview | Two sentences on what the app is and what it runs on. | When the stack changes. |
Commands | The exact commands to install, run, test one file and check types. | Whenever a script in package.json changes. |
Project layout | The handful of folders that matter and what lives in each. | When you add or move a top-level folder. |
Code style | Rules a linter doesn't enforce, such as where database code may live. | When review keeps catching the same thing. |
Workflow | How a change is finished: tests, commit format, what needs a question first. | When the team's process changes. |
Never | The few actions that would cause real damage. | Rarely. Keep this list short. |
Write each rule as an instruction with a reason or a path. "Components never query the database" is easier to follow than "keep a clean architecture".
Variant: a monorepo
Keep the root file about the whole repository, and put package rules next to the package. Claude reads the package file only when it works there.
# Acme monorepo
pnpm workspaces with Turborepo. Run commands from the root.
## Commands
- Everything: `pnpm turbo run build test lint`
- One package: `pnpm --filter @acme/api test`
## Packages
- `apps/web`: the Next.js dashboard. See apps/web/CLAUDE.md.
- `apps/api`: the Hono API. See apps/api/CLAUDE.md.
- `packages/db`: the Drizzle schema, shared by both apps.
Change `packages/db` only together with a migration, and run both apps' tests after.# API
- Routes live in `src/routes`, one file per resource.
- Validate every request body with the Zod schemas in `src/schemas`.
- Tests: `pnpm --filter @acme/api test`. They need `DATABASE_URL` from `.env.test`.Variant: share one file with other agents
If your team also uses Codex, Cursor or another agent that reads AGENTS.md, keep the instructions there and import them. A line starting with @ pulls another file into CLAUDE.md.
@AGENTS.md
## Claude Code
- Use plan mode for changes that touch more than three files.The AGENTS.md template has a starting point for the shared file.