Example result: Write a CLAUDE.md file for your project
AI-generated example · Agent Setup · CLAUDE.md
Prompt at a glance
Category
Text & chat
Works with
Claude Code · Cursor
Length
94 words
Fields to fill
WHAT IT DOES, HOW TO INSTALL, RUN, TEST, LINT, BUILD
Last updated

Write a CLAUDE.md file for your project

CLAUDE.md is a short file Claude Code reads at the start of every session. This prompt helps you write one with your commands, folder map, style and testing rules, keeping only what is not obvious from the code.

text-code-claude-md-file — claude code — 94 words

Help me write a CLAUDE.md file for this project, so an AI coding agent works the way my team does.

Project: [WHAT IT DOES]
Stack: [e.g. Next.js, TypeScript, Prisma, Postgres]
Commands: [HOW TO INSTALL, RUN, TEST, LINT, BUILD]
Rules we follow: [e.g. no default exports, tests next to files, never edit generated code]

Keep it short and specific: project overview in two lines, key commands, folder map, code style rules, testing rules, and things the agent must never do. Only include rules that are not obvious from the code. Use bullet points, not paragraphs.

Short beats long. If a rule is ignored, make it more specific instead of adding more text.

How to use this prompt

From copy to answer in four steps

  1. 1

    Open Claude Code and start a new chat.

  2. 2

    Paste the prompt.

  3. 3

    Replace each [BRACKETED] field with your real details and paste in your own text where asked.

  4. 4

    Reply with follow-ups such as "make it shorter" or "make it sound more like me".

FAQ

About this prompt

Which AI tools work with this prompt?

It is written for Claude Code and Cursor. Paste it into your preferred tool and adjust the wording if the result is off.

What do I need to fill in?

Replace these fields before you send it: WHAT IT DOES, HOW TO INSTALL, RUN, TEST, LINT, BUILD. Each field shows an example in the prompt.

Should I paste private information into the prompt?

Only what the task needs. Remove names, contact details and other sensitive data before pasting a resume or document into any AI tool.

Keep exploring

More chat & writing prompts

See all 424 chat & writing prompts →