NativeAIHub
📋

CLAUDE.md Files

The project instruction file that Claude Code reads automatically. Define coding standards, architecture notes, common commands, and project context so Claude understands your codebase from the start.

Data Source·2 sections·1 min read
codingworkflowproductivity
Install Prompt

Paste this into Claude Code to set it up:

Create a CLAUDE.md file at the root of your project. Include sections for: project overview (what this project does and what tech stack it uses), common commands (build, test, lint, deploy), coding conventions (style rules, import patterns, error handling), architecture notes (how the codebase is organized), and gotchas (things Claude cannot infer from reading the code). Keep it concise and actionable. Claude reads every word, so bloated instructions dilute the important ones.

01What It Does

Auto loaded at session start

CLAUDE.md is a Markdown file that Claude Code reads automatically when you start a session. You never need to paste instructions or remind Claude about your project. Everything in CLAUDE.md becomes part of Claude's understanding before you type your first message. Think of it as the standing briefing document for your AI colleague.
CLAUDE.md files work at multiple levels: global (~/.claude/CLAUDE.md) for personal preferences across all projects, project root (./CLAUDE.md) for team shared conventions, project private (./.claude/CLAUDE.md) for your personal overrides, and subdirectory (./src/CLAUDE.md) for module specific context. Each level adds to the previous, with more specific files taking priority when there is a conflict.

02Structure Guide

1

Project Overview

A brief description of what the project does, the tech stack (framework, language, database, hosting), and the primary entry points. Give Claude the 30 second orientation a new team member would need.

2

Common Commands

Build, test, lint, deploy, and any project specific scripts. List the exact commands so Claude never has to guess. Include flags or environment variables that matter.

3

Coding Conventions

TypeScript strict mode, functional components, import ordering, error handling patterns, naming conventions. The rules that keep your codebase consistent and that Claude should follow.

4

Architecture Notes

How the codebase is organized: folder structure, data flow, API layer, auth patterns. The structural decisions that shape how new code should be written.

5

Gotchas and Warnings

Things Claude cannot infer by reading the code. Webhook verification quirks, import restrictions, known bugs, deployment caveats. These prevent Claude from making mistakes that look reasonable but break things.