claude.mdby SuperMD

// claude.md

Generate CLAUDE.md from any GitHub repo.

Paste a public GitHub URL. SuperMD fetches the repo structure, README, and package.json — then generates a CLAUDE.md that gives Claude everything it needs to work in your codebase.

Public repos only. No auth required.

// what gets detected

Framework & version
Package manager
Key dependencies
npm scripts
Test runner
Linter / formatter
ORM
File structure

Your CLAUDE.md will appear here

// what is claude.md

The file Claude reads before it reads anything else.

CLAUDE.md is a special markdown file that Claude Code reads automatically at the start of every session. It tells Claude what your project is, how to run it, and how to work within it — without you repeating yourself in every prompt.

A well-written CLAUDE.md means Claude immediately knows your tech stack, your commands, your conventions, and your architecture. It stops making assumptions. It stops suggesting the wrong framework. It stops asking questions you've answered a hundred times.

CLAUDE.md
# CLAUDE.md

## Overview
Next.js SaaS app for converting files to markdown.

## Tech Stack
- Framework: Next.js 16 (Turbopack)
- Language: TypeScript
- Styling: Tailwind CSS v4

## Commands
```bash
npm run dev    # start dev server
npm run build  # production build
npm run test   # run Vitest
```

## Conventions
- ESLint + Prettier
- Source code in src/
- App Router — routes are folders in app/

// use cases

When do you need a CLAUDE.md?

Starting a new project with Claude Code

Solo dev

Generate a CLAUDE.md on day one. Claude immediately understands your stack, your commands, and your conventions — no warmup prompts needed.

Onboarding Claude to an existing codebase

Existing projects

Paste your GitHub URL and get a CLAUDE.md that captures your real project state — not a generic template. Claude stops guessing about your architecture.

Consistent behaviour across sessions

Teams

Without CLAUDE.md, every new Claude session starts from zero. With it, Claude behaves consistently — same conventions, same patterns, same assumptions every time.

Reducing repeated context in prompts

Token efficiency

Every token you spend re-explaining your stack is a token wasted. A good CLAUDE.md eliminates the preamble from every prompt and keeps your context window for actual work.

// auto-detection

What SuperMD detects from your repo.

Framework

  • Next.js
  • React
  • Vue
  • Svelte
  • Angular
  • NestJS
  • Go
  • Rust
  • Python

Tooling

  • npm / pnpm / bun / yarn
  • ESLint
  • Prettier
  • Biome
  • TypeScript

Testing

  • Vitest
  • Jest
  • Playwright
  • Cypress

Infrastructure

  • Prisma ORM
  • Drizzle ORM
  • Docker
  • Postgres
  • .env pattern

// faq

Frequently asked questions

Does Claude automatically read CLAUDE.md?

Yes. Claude Code reads CLAUDE.md from your project root automatically at the start of every session. You can also have CLAUDE.md files in subdirectories for per-module context.

What should go in a CLAUDE.md?

The most valuable sections are: (1) a brief project overview, (2) the tech stack with versions, (3) the commands needed to run, build, and test the project, and (4) coding conventions and gotchas. Keep it under 500 tokens — longer files are less reliably followed.

How often should I update my CLAUDE.md?

Update it when your stack changes, when you add major dependencies, or when you notice Claude repeatedly making the same mistake. Think of it as living documentation — it should reflect the current state of your project.

Can I use this for private repos?

The GitHub URL tab only works for public repos. For private repos, use the Paste tab — copy your README.md and package.json and paste them in. The generator works from any text content.

Can I customise the generated CLAUDE.md?

Yes — the output is plain markdown. Copy it, edit it in any text editor, and paste any additional context that SuperMD couldn't detect automatically (e.g. deployment process, third-party integrations, known gotchas).

Is CLAUDE.md the same as a system prompt?

Similar concept, different mechanism. A system prompt is per-conversation. CLAUDE.md is persistent across all Claude Code sessions in a project, and is read from the file system rather than passed via API. It's designed specifically for coding context.