Documentation
Learn how to use the Claude Code Configurator.
What is CLAUDE.md?
CLAUDE.md is a configuration file that tells Claude Code how to work with your project. It defines the AI's persona, your tech stack, coding conventions, allowed commands, forbidden actions, and more. Think of it as the instruction manual that makes Claude Code a project-aware coding assistant tailored to your specific needs.
Place the CLAUDE.md file in the root of your project directory. Claude Code reads it automatically when you start a conversation, giving it full context about your project.
How to use the Configurator
- Choose a template — Browse the template library and pick one that matches your stack. Each template comes pre-loaded with production-ready configuration blocks.
- Customize blocks — In the editor, you can:
- Drag and drop blocks to reorder them
- Toggle blocks on/off (disabled blocks appear as comments)
- Edit block content directly in the textarea
- Double-click block titles to rename them
- Add new blocks from the block library sidebar
- Delete non-required blocks
- Preview in real time — The right panel shows your CLAUDE.md with syntax highlighting, updating live as you type.
- Export — Download as CLAUDE.md file, export as JSON for later import, or copy to clipboard.
Block types reference
| Type | Purpose | Example |
|---|---|---|
| role | Define the AI expert persona and core principles | You are an expert Next.js developer... |
| stack | List all tools, frameworks, and versions | Framework: Next.js 14, Language: TypeScript 5.4 |
| architecture | Describe folder structure and module boundaries | src/app/ for routes, src/components/ for UI... |
| conventions | Define naming, patterns, and coding rules | Use camelCase for variables, PascalCase for components |
| commands | CLI commands Claude is allowed to run | pnpm dev, pnpm build, pnpm test |
| forbidden | Actions Claude must never take | NEVER use any in TypeScript |
| testing | Test strategy, coverage, and frameworks | Vitest for unit tests, 80% coverage minimum |
| deployment | CI/CD, Docker, and infrastructure patterns | Docker multi-stage build, deploy on merge to main |
| security | Security policies and OWASP guidelines | Always validate input, use parameterized queries |
| style | Prettier, ESLint, and formatting rules | Single quotes, 2-space indent, trailing commas |
| mcp | MCP server configurations | filesystem, database, or custom tool servers |
| agents | Custom agent definitions | Code reviewer, security auditor, TDD guide |
| hooks | Shell commands on Claude Code events | Pre-commit, post-tool-use hooks |
| custom | Freeform instructions | Any additional project-specific guidance |
Using the exported CLAUDE.md
After exporting, place the CLAUDE.md file in the root of your project directory. Claude Code will automatically read it when you start working in that directory. No additional setup is needed.
Importing a JSON config
You can save your configuration as JSON to share with teammates or back up your setup. To import a JSON config, click the Export dropdown in the configurator and select "Import JSON". The file must be a valid JSON with version "1.0" and a blocks array.