What is generate-claude-md?

A command that examines an existing codebase and writes a CLAUDE.md file, which gives Claude Code project-specific instructions.

Use it when adding Claude Code guidance to an existing project.

It removes the need to write those instructions by hand and helps record how the codebase should be understood and worked on.

How fltman/project-scaffolder configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to fltman/project-scaffolder. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/fltman/project-scaffolder/main/.claude/commands/generate-claude-md.md

Clone the repo

git clone --depth 1 https://github.com/fltman/project-scaffolder

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/commands/fltman/project-scaffolder/generate-claude-md/github.svg)](https://agentmods.dev/commands/fltman/project-scaffolder/generate-claude-md)

Your own site

<a href="https://agentmods.dev/commands/fltman/project-scaffolder/generate-claude-md"><img src="https://agentmods.dev/badge/commands/fltman/project-scaffolder/generate-claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/commands/fltman/project-scaffolder/generate-claude-md"><img src="https://agentmods.dev/badge/commands/fltman/project-scaffolder/generate-claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.

When invoked 572 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00000	$0.00572
Opus 5.5	$0.00000	$0.00229
Sonnet 5.5	$0.00000	$0.00114
Haiku 4.5	$0.00000	$0.00057

Measured 2mo ago against content hash 5e0e2c4bc48b, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

generate-claude-md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude/commands/generate-claude-md.md · 100 lines

How it starts

The opening of the file, as written. The whole thing — 100 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Generate CLAUDE.md for Existing Project

Analyze an existing codebase and generate an optimized CLAUDE.md file.

Arguments

$ARGUMENTS can optionally specify a target directory. Default: current directory.

Analysis Process

Step 1: Detect Project Type

Look for these indicators:

package.json → Node.js/JavaScript/TypeScript
pyproject.toml / requirements.txt / setup.py → Python
Cargo.toml → Rust
go.mod → Go
pom.xml / build.gradle → Java
Gemfile → Ruby

Step 2: Analyze Configuration Files

Read and extract:

Scripts/Commands: From package.json scripts, Makefile, etc.
Dependencies: Key frameworks and libraries
Tool Configs: ESLint, Prettier, Ruff, MyPy, etc.

Step 3: Examine Project Structure

Map the directory structure and identify:

Source code directories
Test directories
Configuration directories
Build output directories (to exclude)

Step 4: Look for Existing Documentation

Read if present:

README.md - Project description and setup
CONTRIBUTING.md - Contribution guidelines
Existing CLAUDE.md - To preserve custom instructions

Step 5: Generate CLAUDE.md

Create a CLAUDE.md following the WHAT/WHY/HOW framework:

# Project Name

> Brief description from README or package description

## Tech Stack

- List detected technologies
- Key frameworks and libraries

## Project Structure

- Map key directories
- Note important files

## Commands

```bash
# List detected commands from package.json/Makefile/etc.

Verification

List available lint commands
List available test commands
List type check commands

File Boundaries

Safe to edit: source directories
Read-only: config, generated files
Never touch: node_modules, venv, build outputs


### Step 6: Apply Best Practices

Ensure the generated CLAUDE.md:
1. Is **concise** (under 200 lines ideally)
2. Contains only **universally applicable** instructions
3. References **specific commands** the user can run
4. Defines clear **file boundaries**
5. Does NOT include style guidelines (use linters instead)

Read the full file on GitHub · 100 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2mo ago First seen · 100 lines · 0 tokens per session scan A 5e0e2c4bc48b

Subscribe to this mod's changes

generate-claude-md is a command published in the GitHub repository fltman/project-scaffolder (88 stars, last pushed 9d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 572 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Building agents

generate-claude-md next to 6 commands from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
generate-claude-mdfltman/project-scaffolder	Command	88	9d ago	MIT	A	0	Claude Code
checklistgithub/spec-kit	Command	148k	yesterday	MIT	A	13	Claude Code
clarifygithub/spec-kit	Command	148k	yesterday	MIT	A	27	Claude Code
specifygithub/spec-kit	Command	148k	yesterday	MIT	A	13	Claude Code
analyzegithub/spec-kit	Command	148k	yesterday	MIT	A	26	Claude Code
convergegithub/spec-kit	Command	148k	yesterday	MIT	A	35	Claude Code
implementgithub/spec-kit	Command	148k	yesterday	MIT	A	14	Claude Code

project-scaffolder: Command for Claude Code