CLAUDE.md is a special file that Claude reads automatically when it starts working on a project. It contains project-specific instructions, conventions, and context. Claude Board includes a built-in editor for managing this file.
What is CLAUDE.md?
A CLAUDE.md file at the root of your project tells Claude:
- How the project is structured
- What conventions to follow
- Which commands to use for building and testing
- Important architectural decisions
# Project: My API
## Stack
- Node.js + Express + TypeScript
- PostgreSQL with Prisma ORM
- Jest for testing
## Commands
- `npm run build` — compile TypeScript
- `npm test` — run all tests
- `npm run lint` — check code style
## Conventions
- Use Prisma for all database access
- All endpoints return JSON with `{ data, error }` shape
- Write integration tests for every new endpoint
Built-in Editor
Claude Board provides a text editor in the project settings for viewing and editing the CLAUDE.md file. Changes are saved directly to the file in your project’s working directory.
Open project settings
Click the gear icon on your project dashboard.
Navigate to CLAUDE.md tab
Select the CLAUDE.md section.
Edit and save
Modify the content and click Save. The file is written to your project’s working directory.
CLAUDE.md vs Context Snippets
| Feature | CLAUDE.md | Context Snippets |
|---|
| Location | File in your repo | Stored in Claude Board’s database |
| Versioned | Yes, committed to git | No |
| Toggling | Always active | Can be enabled/disabled individually |
| Scope | Read by Claude CLI directly | Injected by Claude Board into prompt |
Use CLAUDE.md for stable project conventions that should live in the repo. Use context snippets for temporary rules or instructions that change frequently.
