project-recap

A visual HTML report that summarizes a software project's current state, recent decisions, and areas of accumulated complexity. It is designed to help someone rebuild an understanding of the project.

In plain words
What is it for?
Use it for team onboarding, personal project recall, or a leadership summary. It can cover a chosen time period and produce an editable source plus a standalone HTML report.
Why use it?
It reduces the time spent piecing together project history and architecture from scattered files and discussions. It also makes unclear or costly parts of the project easier to spot.

Command

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/theclaymethod/artifacture/project-recap
Clone the repo
git clone --depth 1 https://github.com/theclaymethod/artifacture
Per session 23 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,840 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 86% copy Near-identical to another mod 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.00023 $0.01840
Opus 5 $0.00012 $0.00920
Sonnet 5 $0.00005 $0.00368
Haiku 4.5 $0.00002 $0.00184

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

Security

Grade A, and why

project-recap 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 2d 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.

Origin

This is a copy

86% identical to project-recap — 16 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

plugins/visual-explainer/commands/project-recap.md · 70 lines

How it starts

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

Load the visual-explainer skill and read cards/project-recap.md, then generate a comprehensive visual project recap as a self-contained HTML page.

Authoring contract. Prefer the MDX/React pipeline after the project-history and architecture fact-gathering checkpoint. Write the editable recap as .mdx by default, or .tsx when the recap needs custom interaction, generated SVG logic, or local state. Use shared components from visual-explainer-mdx/components.tsx, then export the generated standalone HTML with:

npm run ve:export -- <source.mdx> --out ~/.agent/diagrams/<slug>-project-recap.html

The generated HTML is the artifact, not the source of truth. Revise the MDX/TSX source when facts change or point-and-click feedback arrives, then re-export.

Clarify. This is a Tier 1 command per ./references/clarify.md. The time window usually comes from $1 (e.g., 2w, 30d, 3m) or defaults to 2w. If audience or depth is unclear (team onboarding vs. self-recall vs. leadership summary), ask 1 question. Bypass with --no-ask.

Follow the visual-explainer skill workflow. Read the reference template, CSS patterns, and mermaid theming references before generating. Use a warm editorial or paper/ink aesthetic with muted blues and greens, but vary fonts and palette from previous diagrams.

Time window — determine the recency window from $1:

  • Shorthand like 2w, 30d, 3m: parse to git's --since format (2w"2 weeks ago", 30d"30 days ago", 3m"3 months ago")
  • If $1 doesn't match a time pattern, treat it as free-form context and use the default window
  • No argument: default to 2w (2 weeks)

Data gathering phase — run these first to understand the project:

  1. Project identity. Read README.md, CHANGELOG.md, package.json / Cargo.toml / pyproject.toml / go.mod for name, description, version, dependencies. Read the top-level file structure.

  2. Recent activity. git log --oneline --since=<window> for commit history. git log --stat --since=<window> for file-level change scope. git shortlog -sn --since=<window> for contributor activity. Identify which areas of the codebase were most active.

  3. Current state. Check for uncommitted changes (git status). Check for stale branches (git branch --no-merged). Look for TODO/FIXME comments in recently changed files. Read progress docs if they exist (~/.agent/memory/{project}/progress.md, ~/.pi/agent/memory/{project}/progress.md, .pi/todos/, or similar).

  4. Decision context. Read recent commit messages for rationale. If running in the same session as recent work, mine the conversation history. Read any plan docs, RFCs, or ADRs in the project directory.

  5. Architecture scan. Read key source files to understand the module structure and dependencies. Focus on entry points, public API surface, and the files most frequently changed in the time window.

Verification checkpoint — before generating HTML, produce a structured fact sheet of every claim you will present in the recap:

  • Every quantitative figure: commit counts, file counts, line counts, branch counts
  • Every module, function, and type name you will reference
  • Every behavior and architecture description
  • For each, cite the source: the git command output that produced it, or the file:line where you read it Verify each claim against the code. If something cannot be verified, mark it as uncertain rather than stating it as fact. This fact sheet is your source of truth during HTML generation — do not deviate from it.

Optional hero image — if surf CLI is available (which surf), generate a hero banner via surf gemini --generate-image --aspect-ratio 16:9 that visually captures the project's identity or domain. Match the style to the page's palette. Embed as base64 data URI using the .hero-img-wrap pattern from css-patterns.md. Place above or just below the title. Skip if surf isn't available — the page should stand on its own.

Read the full file on GitHub · 70 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. 2d ago First seen · 70 lines · 23 tokens per session scan A 196fd53c2d39

Subscribe to this mod's changes

project-recap is a command published in the GitHub repository theclaymethod/artifacture (2 stars, last pushed 9d ago), licensed MIT. It adds 23 tokens to every session and 1,840 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. It is 86% identical to project-recap, differing in 16 lines, and is treated as a copy.