skills.rest
Jhabbig
JhabbigCOMMUNITY
Explore all skills by this author →
GitHub

scan

Scan repositories to identify Skill units and generate metadata.

Updated Apr 5, 2026
Search Tags:#codebase analysis#documentation generation#agent instructions#skill metadata#repository scan#architecture detection
One-click install
npx skills add https://github.com/Jhabbig/Habbig --skill scan-jhabbig
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: scan
Source: https://github.com/Jhabbig/Habbig/tree/main/.claude/plugins/wshobson/ship-mate/skills/scan
Command: npx skills add https://github.com/Jhabbig/Habbig --skill scan-jhabbig

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes the manual effort of understanding a repository by scanning the codebase and producing accurate project documentation and agent instructions.

Core Features & Use Cases

  • Full and Delta Scans: Performs a first-pass repository scan or re-scans only changed files when the project already has documentation.
  • Architecture Awareness: Detects framework, dependency, structure, and communication patterns so downstream agents can work safely and consistently.
  • Documentation Generation: Produces and updates project-doc and AGENTS files that capture stack context, conventions, testing, and guardrails.
  • Use Case: A maintainer can run this Skill on a newly cloned monorepo to generate a baseline project map and then rerun it after changes to keep docs current.

Quick Start

Ask the Skill to scan the repository and generate the project documentation and agent instructions for the current codebase.

Frequently Asked Questions about scan

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate agent-ready documentation from a codebase?▼

Codebase documentation generation works by scanning the repository to discover SKILL.md files, infer dependencies, and classify structure. It produces project-doc and AGENTS files that capture stack context, conventions, testing, and guardrails for downstream agents.

What is architecture detection in a repository scan?▼

Architecture detection identifies framework, dependency, structure, and communication patterns within a codebase during a repository scan. This allows downstream agents to understand the project layout and work safely and consistently with the codebase.

Can I re-scan only changed files instead of the entire repository?▼

Yes, delta scans allow you to re-scan only changed files when the project already has existing documentation. This incremental update keeps project-doc and AGENTS files current without performing a full repository scan every time.

How do I identify valid Skill units and entry points in a codebase?▼

Valid Skill units are identified by reading directory contents and skill frontmatter to verify entry points, optional components, and safety risks. The scan extracts this metadata to validate and classify each unit within the repository structure.

What limitations exist when scanning a monorepo for skill metadata?▼

Scanning a monorepo requires readable directory contents and valid SKILL.md files to infer dependencies and verify entry points. The scan cannot generate accurate project documentation if skill frontmatter is missing or if safety risks cannot be validated.

Related Skills

Explore More Software Engineering Skills→
lawve-ailawve-ai
630

eu-ai-act-report-oliver-schmidt-prietz

Scan repositories for SKILL.md frontmatter and generate standardized YAML metadata.

Official
Advanced
AgentSystemLabsAgentSystemLabs
121

sync-docs

Update existing documentation files to match current codebase changes.

Official
Advanced
nist0nist0

repo-understanding

Generate codebase summaries with module maps, entry points, and data flows.

Community
Advanced
saschadudkin-sketchsaschadudkin-sketch

code-review

Automate code review for rezidence4/DomHub repository changes.

Community
Advanced