
Scan
Bootstrap or refresh AGENTS.md and project-doc.md so Claude Code and other agents understand your repo structure without manual doc drift.
Install
npx skills add https://github.com/wshobson/agents --skill scanWhat is this skill?
- Full codebase scan on first use; smart delta scan on later runs to detect architectural drift
- Generates project-doc.md and AGENTS.md tailored to the current repository layout
- Optional deepen with understand-anything; optional large-output routing via context-mode with native find/grep/git fallb
- Updates AGENTS.md only when architectural changes are detected, with human confirmation before overwrite
- Technical analyst workflow: optional plugin check in Step 1 before scan execution
Adoption & trust: 822 installs on skills.sh; 36.5k GitHub stars; 1/3 security scanners passed (skills.sh audits).
Recommended Skills
Journey fit
First-run scanning happens when you set up agent-driven development; it is the canonical entry point for repository context files. Produces and maintains agent-facing documentation (AGENTS.md, project-doc.md), which is core agent-tooling infrastructure for the build phase.
Common Questions / FAQ
Is Scan safe to install?
skills.sh reports 1 of 3 security scanners passed. Review the Security Audits panel on this page before installing in production.
SKILL.md
READMESKILL.md - Scan
# 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: ``` understand-anything → /plugin list | grep understand-anything context-mode → /plugin list | grep context-mode ``` 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: > ``` > /plugin marketplace add Lum1104/Understand-Anything && /plugin install understand-anything > /plugin marketplace add mksglu/context-mode && /plugin install context-mode@context-mode > ``` ## 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): ```md # Project Documentation > Generated: [timestamp] | Mode: FULL ## Tech Stack - Runtime: [e.g. Node.js 20, Python 3.11] - Language: [e.g. TypeScript, Python] - Framework: [e.g. Next.js 14 App Router, FastAPI] - Database: [e.g. PostgreSQL via Prisma] - Styling: [e.g. Tailwind CSS] - State Management: [e.g. Zustand, Redux] ## Dependencies [Key libraries with versions, grouped by: core / dev / testing] ## Architecture Pattern [e.g. Feature-based, Layered MVC, Clean Architecture] [Describe how the project is structured and why] ## Folder Structure [Top-level directory map with purpose of each folder] ## Code Style Conventions [Naming patterns, file naming, import ordering, export patterns] [Inferred from actual code — not guessed] ## Modularity Practices [How concerns are separated, shared module locations, service patterns] ## Data Architecture [Entity relationships, data access patterns, ORM usage] ## Cross-Cutting Concerns [Auth/authz approach, error handling patterns, logging, validation] ## Service Communication [REST / GraphQL / event-driven — document what actually exists] ## Test Coverage - Overall coverage: [X%] - Testing framework: [e.g. Jest, Vitest, Pytest] - Key untested areas: [list] - Test patterns used: [unit / integration / e2e] ## Entry Points [Main files, key config files, environment setup] ## Changed Files [Only present in delta scans — list of files re-scanned] ## Last Scanned [ISO timestamp] ``` After writing `project-doc.md`, proceed to **Step 4** to generate `AGENTS.md`. ## Step 3B: Delt