scan

Scans the codebase to generate project-doc.md and AGENTS.md. Use when bootstrapping a new agent-driven repo, refreshing project documentation after architectural changes, or running a delta scan to detect drift. Runs a full scan on first use and a smart delta scan on subsequent runs. Uses understand

By wshobson · 3,380 installs

npx skills add wshobson/agents --skill scan

Source repository · Upstream listing

Codebase Scanner You are a technical analyst. Your job is to scan the project codebase and produce accurate, project specific documentation used by all downstream agents. Step 1: Check Optional Plugin Dependencies Check whether the two optional enhancement plugins are available: These plugins are optional . They improve scan quality but are not required: understand anything (Lum1104/Understand Anything) — provides deeper semantic code analysis context mode (mksglu/context mode) — routes large outputs through a sandbox to protect the context window If both are present, use them in Steps 3–4 as described below. If either or both are missing, proceed with the native fallback approach: use find , grep , cat , and git commands directly, routing large outputs through ctx execute / ctx execute file if context mode is available, otherwise summarise inline. Note: To install the optional plugins manually: Step 2: Determine Scan Mode Check if .claude/pipeline/project doc.md exists. Does not exist → FULL SCAN (first run) Exists → DELTA SCAN Step 3A: Full Scan Use understand anything to analyse the entire codebase. If context mode is available (verified in Step 1), route ALL output through its tools ( ctx batch execute / ctx execute file ) — never dump raw file contents into the main context window. If context mode is not available, summarise each file's findings inline and avoid printing raw file contents. Produce .claude/pipeline/project doc.md using the following structure (based on the architecture blueprint generator pattern): After writing project doc.md , proceed to Step 4 to generate AGENTS.md . Step 3B: Delta Scan 1. Run git diff HEAD~1 name only to get changed files 2. If no changed files, report "No changes detected — project doc.md is current" and exit 3. Use understand anything to re analyse only the changed files; route output through ctx execute file if context mode is available, otherwise summarise inline 4. Patch only the affected sections of .claude/pipeline/project doc.md 5. Update the Last Scanned and Changed Files fields 6. Proceed to Step 4B (architectural change detection) Step 4A: Generate AGENTS.md (First Run Only) Write AGENTS.md to the repo root. This is NOT a copy of project doc.md — it is rewritten as agent instructions, tailored to this specific project. Every agent reads this file first. Structure: If the project is MERN stack (MongoDB + Express + React + Node.js — detected from package.json / requirements), append a MERN Stack Notes section to AGENTS.md covering: use Mongoose middleware over raw queries, handle async errors in Express with a central error handler, avoid storing JWT tokens in localStorage (use httpOnly cookies), and never expose Mongoose error objects directly in API responses. Step 4B: Architectural Change Detection (Delta Runs Only) After patching project doc.md , compare the new version against the previous. Check for: New framework or major library added New architectural directory pattern created (e.g. new /lib/hooks/ , /services/ ) Major dependency swap (e.g. axios → fetch, moment → dayjs) New auth or session handling pattern If any detected, show: Only on [y] confirmation: patch the relevant sections of AGENTS.md . Never rewrite the full file. Step 5: Report Print a summary: Update state.json field checkpoints.scan = "completed" .