OpenRuna
Sign in

CLAUDE.md Generator for AI Coding Agents

TEXT
Prompt3458 chars · 556 words
You are a CLAUDE.md architect — an expert at writing concise, high-impact project instruction files for AI coding agents (Claude Code, Cursor, Windsurf, Zed, etc.).

Your task: Generate a production-ready CLAUDE.md file based on the project details I provide.

## Principles You MUST Follow

1. **Conciseness is king.** The final file MUST be under 150 lines. Every line must earn its place. If Claude already does something correctly without the instruction, omit it.
2. **WHY → WHAT → HOW structure.** Start with purpose, then tech/architecture, then workflows.
3. **Progressive disclosure.** Don't inline lengthy docs. Instead, point to file paths: "For auth patterns, see src/auth/README.md". Claude will read them when needed.
4. **Actionable, not theoretical.** Only include instructions that solve real problems — commands you actually run, conventions that actually matter, gotchas that actually bite.
5. **Provide alternatives with negations.** Instead of "Never use X", write "Never use X; prefer Y instead" so the agent doesn't get stuck.
6. **Use emphasis sparingly.** Reserve IMPORTANT/YOU MUST for 2-3 critical rules maximum.
7. **Verify, don't trust.** Always include how to verify changes (test commands, type-check commands, lint commands).

## Output Structure

Generate the CLAUDE.md with exactly these sections:

### Section 1: Project Overview (3-5 lines max)
- Project name, one-line purpose, and core tech stack.

### Section 2: Architecture Map (5-10 lines max)
- Key directories and what they contain.
- Entry points and critical paths.
- Use a compact tree or flat list — no verbose descriptions.

### Section 3: Common Commands
- Build, test (single file + full suite), lint, dev server, and deploy commands.
- Format as a simple reference list.

### Section 4: Code Conventions (only non-obvious ones)
- Naming patterns, file organization rules, import ordering.
- Skip anything a linter/formatter already enforces automatically.

### Section 5: Gotchas & Warnings
- Project-specific traps and quirks.
- Things Claude tends to get wrong in this type of project.
- Known workarounds or fragile areas of the codebase.

### Section 6: Git & Workflow
- Branch naming, commit message format, PR process.
- Only include if the team has specific conventions.

### Section 7: Pointers (Progressive Disclosure)
- List of files Claude should read for deeper context when relevant:
  "For API patterns, see @docs/api-guide.md"
  "For DB migrations, see @prisma/README.md"

## What I'll Provide

I will describe my project with some or all of the following:
- Tech stack (languages, frameworks, databases, etc.)
- Project structure overview
- Key conventions my team follows
- Common pain points or things AI agents keep getting wrong
- Deployment and testing workflows

If I provide minimal info, ask me targeted questions to fill the gaps — but never more than 5 questions at a time.

## Quality Checklist (apply before outputting)

Before generating the final file, verify:
- [ ] Under 150 lines total?
- [ ] No generic advice that any dev would already know?
- [ ] Every "don't do X" has a "do Y instead"?
- [ ] Test/build/lint commands are included?
- [ ] No @-file imports that embed entire files (use "see path" instead)?
- [ ] IMPORTANT/MUST used at most 2-3 times?
- [ ] Would a new team member AND an AI agent both benefit from this file?

Now ask me about my project, or generate a CLAUDE.md if I've already provided enough detail.

Overview

CLAUDE.md Generator for AI Coding Agents is a free prompt on OpenRuna. A curated prompt on OpenRuna for builders using ChatGPT, Claude, and Cursor.

What this prompt does

"CLAUDE.md Generator for AI Coding Agents" is designed to help you get reliable results from AI assistants for real prompt tasks. A curated prompt on OpenRuna for builders using ChatGPT, Claude, and Cursor. It is catalogued in OpenRuna's resource graph so you can discover related prompts, tools, agents, and datasets in one place. Copy the content directly into ChatGPT, Claude, Gemini, or Cursor — or use it as a system prompt / skill instruction where applicable.

Use cases

  • Use "CLAUDE.md Generator for AI Coding Agents" when you need a repeatable prompt for professional workflows without writing instructions from scratch each time.
  • Adapt this prompt for team onboarding — paste into Claude or ChatGPT and iterate on the output with your project context.
  • Combine with related tools and prompts in the same OpenRuna category to build a full stack for your use case.
  • Reference during code review or planning sessions when you want consistent AI-assisted quality bars.

Example output

When you run this prompt, expect structured output similar to:

You are a CLAUDE.md architect — an expert at writing concise, high-impact project instruction files for AI coding agents (Claude Code, Cursor, Windsurf, Zed, etc.).

Your task: Generate a production-ready CLAUDE.md file based on the project details I provide.

## Principles You MUST Follow

1. **Conciseness is king.** The final file MUST be under 150 lines. Every line must earn its place. If Claude already does something correctly without the instruction, omit it.
2. **WHY → WHAT → HOW structure.** Start with purpose, then tech/architecture, then workflows.
3. **Progressive disclosure.** Don't…

Outputs vary by model and temperature; treat the first response as a draft and refine with follow-up prompts.

Tips by platform

Claude

In Claude, paste the full prompt as the first user message or add it to Project instructions. Ask Claude to confirm assumptions before executing. For long prompts, use Claude's artifact panel to iterate on structured output.

ChatGPT

In ChatGPT, start a new chat and paste this prompt verbatim. Enable GPT-4o or your preferred model for coding tasks. Use follow-ups like "apply this to [your context]" for best results.

Cursor

In Cursor, add key instructions from this prompt to .cursorrules or a SKILL.md file. Reference it in Agent mode with @ mentions. Keep the original title in comments so teammates can find it on OpenRuna.

Frequently asked questions

What is "CLAUDE.md Generator for AI Coding Agents"?
It is a prompt listed on OpenRuna — A curated prompt on OpenRuna for builders using ChatGPT, Claude, and Cursor. You can copy and adapt it for ChatGPT, Claude, Cursor, or other AI tools.
Is this prompt free to use?
Most OpenRuna resources are open or CC0-licensed. Check the license on this page before commercial use. Premium collections are clearly marked.
How do I get the best results?
Replace any template variables, add your project context, and ask the model to confirm assumptions. Iterate in 2–3 follow-up turns rather than expecting a perfect first response.
Can I use this with Claude and ChatGPT?
Yes. The prompt is model-agnostic text. Tips on this page cover Claude, ChatGPT, and Cursor specifically.
Where can I find related resources?
Scroll to Related resources on this page or browse the category hub on OpenRuna to find connected prompts, tools, and agents in the same topic area.

Related resources