readme-maker

readme-maker is a command for Claude Code from luanmorenommaciel/agentspec. It costs 21 tokens per session (2,005 once invoked), scanned A, original, MIT.

A command that examines a codebase and creates a README.md, the standard guide that explains a software project. It can produce a minimal or comprehensive version and check its examples and links before saving.

In plain words
What is it for?
It helps document a project's structure, technologies, coding patterns, setup steps, and usage instructions.
Why use it?
It removes the need to write project documentation from scratch or keep it manually aligned with the code.

Command for Claude Code

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add commands/luanmorenommaciel/agentspec/readme-maker
Clone the repo
git clone --depth 1 https://github.com/luanmorenommaciel/agentspec

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.

agentmods badge for readme-maker

README.md
[![agentmods](https://agentmods.dev/badge/commands/luanmorenommaciel/agentspec/readme-maker.svg)](https://agentmods.dev/commands/luanmorenommaciel/agentspec/readme-maker)
Your own site
<a href="https://agentmods.dev/commands/luanmorenommaciel/agentspec/readme-maker"><img src="https://agentmods.dev/badge/commands/luanmorenommaciel/agentspec/readme-maker.svg" alt="Measured on agentmods" height="20"></a>
Per session 21 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 2,005 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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.

ModelPer sessionOnce invoked
Fable 5 $0.00021 $0.02005
Opus 5 $0.00010 $0.01002
Sonnet 5 $0.00004 $0.00401
Haiku 4.5 $0.00002 $0.00200

Measured 3d ago against content hash 5d31ba08b540, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

readme-maker 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 3d 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/core/readme-maker.md · 373 lines

How it starts

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

README Maker Command

Generates a professional README.md by combining codebase exploration with documentation best practices.

Usage

/readme-maker                        # Full analysis → README.md
/readme-maker --output docs/         # Output to specific directory
/readme-maker --style minimal        # Minimal README (Quick Start focus)
/readme-maker --style comprehensive  # Full documentation (default)
/readme-maker --dry-run              # Preview without saving

What It Does

  1. Explores codebase using codebase-explorer patterns
  2. Analyzes project structure, tech stack, and patterns
  3. Generates README.md following code-documenter standards
  4. Validates all examples and links before saving

Execution Flow

┌─────────────────────────────────────────────────────────────┐
│  README-MAKER WORKFLOW                                       │
├─────────────────────────────────────────────────────────────┤
│                                                             │
│  Phase 1: EXPLORE (codebase-explorer patterns)              │
│  ├─ Scan root structure (ls, package files, configs)        │
│  ├─ Map source code (Glob patterns by language)             │
│  ├─ Identify tech stack and frameworks                      │
│  ├─ Count files, tests, documentation                       │
│  └─ Calculate health score                                  │
│                                                             │
│  Phase 2: EXTRACT (project metadata)                        │
│  ├─ Read package.json / pyproject.toml / Cargo.toml         │
│  ├─ Parse existing README (if present)                      │
│  ├─ Detect entry points (main, index, handler)              │
│  ├─ Find installation/setup commands                        │
│  └─ Identify environment variables                          │
│                                                             │
│  Phase 3: GENERATE (code-documenter patterns)               │
│  ├─ Create compelling project description                   │
│  ├─ Build Quick Start with tested commands                  │
│  ├─ Document features with examples                         │
│  ├─ Add architecture overview (if complex)                  │
│  └─ Include contributing guidelines                         │
│                                                             │
│  Phase 4: VALIDATE (quality checks)                         │
│  ├─ Test all installation commands                          │
│  ├─ Verify code examples work                               │
│  ├─ Check all links resolve                                 │
│  └─ Ensure no placeholder text remains                      │
│                                                             │
│  Phase 5: OUTPUT                                            │
│  ├─ Write README.md to project root                         │
│  └─ Report summary of what was generated                    │
│                                                             │
└─────────────────────────────────────────────────────────────┘

Read the full file on GitHub · 373 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.

  1. 3d ago First seen · 373 lines · 21 tokens per session scan A 5d31ba08b540

Subscribe to this mod's changes

readme-maker is a command published in the GitHub repository luanmorenommaciel/agentspec (244 stars, last pushed yesterday), licensed MIT. It adds 21 tokens to every session and 2,005 once invoked, about $0.0001 per session on Opus 5. 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-09-01.