codebase-insight

Analyzes an existing codebase's modules, interfaces, and constraints into a read-only inventory report.

Updated Jan 12, 2026
One-click install
npx skills add https://github.com/ab300819/keel-workflow --skill codebase-insight-ab300819
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: codebase-insight
Source: https://github.com/ab300819/keel-workflow/tree/main/skills/codebase-insight
Command: npx skills add https://github.com/ab300819/keel-workflow --skill codebase-insight-ab300819

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? When inheriting or revisiting an existing codebase, teams lack a structured, up-to-date picture of system boundaries, modules, public interfaces, and technical constraints. This Skill performs a read-only scan of the repository and produces a standardized inventory report without modifying any code. ## Core Features & Use Cases - Read-only codebase scanning: Detects language/framework, maps directory structure and module boundaries, extracts routes, handlers, ORM models, and configuration constraints. - Commit-hash caching: Skips redundant scans by comparing the stored commit hash and schema version against the current HEAD, with a --force flag for full rescans. - Multi-repo support: Inventories multiple code roots with label-prefixed modules and produces a cross-repository relationship section covering dependency direction and version coupling. - Use Case: Before planning a refactor or writing a project baseline, run the scan to get docs/codebase-insight.md listing 5 modules, 23 interfaces, and 8 data objects with their tech stack constraints. ## Quick Start Ask the AI to run a read-only inventory of the current repository and generate the codebase-insight report under the docs directory.

Frequently Asked Questions about codebase-insight

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

FAQPage Schema
How do I generate an inventory report of an existing codebase?

Run the codebase-insight scan, which detects the language and framework, maps modules, extracts routes and data models, and writes a structured report to docs/codebase-insight.md. It never modifies source code.

How does codebase scanning avoid redundant re-analysis?

The scan stores the current git commit hash and schema version in the report frontmatter. On subsequent runs it compares these against HEAD and skips the scan when they match; use the --force flag to override the cache.

Can codebase analysis handle multiple repositories or code roots?

Yes. Each code root is inventoried separately with label-prefixed module names, and an additional cross-repository section documents dependency direction, interface contracts, and version coupling points.

What is the difference between codebase-insight and retrofit?

codebase-insight only records observable facts about the code without judgment. Retrofit establishes a project baseline with purpose, boundaries, guardrails, and known unknowns, which requires asking questions and making decisions.

When should I not use a read-only codebase inventory?

Skip it when you need requirement definition, progress tracking, or per-file module documentation. Those belong to requirements, onboard, and code-self-describe workflows respectively.