grimoire-discover

Generate a structured codebase map with index.yml and area docs.

Updated Jan 26, 2025

Search Tags:#architecture #documentation #codebase #mapping #snapshot #graph #grimoire

Ready to run

npx skills add https://github.com/jlissner/lissner.io --skill grimoire-discover

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: grimoire-discover
Source: https://github.com/jlissner/lissner.io/tree/main/.claude/skills/grimoire-discover
Command: npx skills add https://github.com/jlissner/lissner.io --skill grimoire-discover

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate a structured map of a codebase from a structural snapshot to help teams understand layout, dependencies, and reusable patterns.

Core Features & Use Cases

Generate .grimoire/docs/ including an index.yml and area docs from the snapshot
Leverage optional graph data (if available) to enrich symbol-level context and architecture overview
Produce persistent documentation artifacts (index.yml, area docs, and data schema) to guide future changes

Quick Start

Run grimoire map to generate a structural snapshot, then trigger /grimoire:discover to produce area docs and a data schema.

Frequently Asked Questions about grimoire-discover

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

FAQPage Schema

How do I generate a codebase map from a structural snapshot?▼

To generate a codebase map from a structural snapshot, you run the snapshot generation command and then trigger the discover process. This produces an index file and area docs for long-term architectural discoverability.

What is the best way to document codebase architecture and identify reusable utilities?▼

Documenting codebase architecture and identifying reusable utilities is best done by generating a structured map from a structural snapshot. This approach automatically produces persistent documentation artifacts detailing dependencies and reusable patterns.

Does codebase mapping work with optional graph data to enrich architecture documentation?▼

Yes, codebase mapping works with optional graph data to enrich architecture documentation. When graph data is available, it provides symbol-level context that deepens the architectural overview and guides code organization.

Can I use snapshot data to guide code organization across different areas of a project?▼

Yes, you can use snapshot data to guide code organization across different project areas. The mapping process generates dedicated area docs and a data schema that outline layout and dependencies to direct future changes.

What format does the codebase mapping output for long-term discoverability?▼

The codebase mapping outputs a structured directory containing an index.yml file and specific area docs for long-term discoverability. These persistent documentation artifacts capture the architecture and data schema.