codemap

Map a codebase into seven planning documents in .planning/codebase/.

114|13|Updated Jan 8, 2026
One-click install
npx skills add https://github.com/jellydn/my-ai-tools --skill codemap
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: codemap
Source: https://github.com/jellydn/my-ai-tools/tree/main/skills/codemap
Command: npx skills add https://github.com/jellydn/my-ai-tools --skill codemap

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill orchestrates the creation of seven planning documents to provide a comprehensive map of a codebase, enabling faster onboarding and architectural clarity.

Core Features & Use Cases

  • Seven structured docs: STACK.md, INTEGRATIONS.md, ARCHITECTURE.md, STRUCTURE.md, CONVENTIONS.md, TESTING.md, and CONCERNS.md.
  • Onboarding and planning: Ideal for bringing new developers up to speed and planning major refactors.
  • Automated templating: Uses standard templates and parallel agents to produce consistent documentation.

Quick Start

Start mapping a repository to generate the planning docs in .planning/codebase/. For example, run the codemap skill against your project root to create the seven documents and populate the directory.

Frequently Asked Questions about codemap

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

FAQPage Schema
How do I generate architecture and onboarding documentation for an entire codebase?

To generate architecture and onboarding documentation, you map your codebase into seven structured markdown files. This process orchestrates parallel agents against your repository to produce STACK.md, INTEGRATIONS.md, and ARCHITECTURE.md for quick reference.

What is the best way to document project structure and conventions for new developers?

Documenting project structure and conventions involves creating standardized planning documents like STRUCTURE.md and CONVENTIONS.md. This automated mapping approach uses reusable templates to capture essential onboarding context, bringing new developers up to speed faster.

How does automated codebase mapping work for planning major refactors?

Automated codebase mapping works by orchestrating parallel agents across an entire repository to capture architecture and onboarding context. It applies reusable templates to write seven planning documents into a designated directory for review.

Can I generate testing and integration documentation without manual writing?

Yes, you can generate testing and integration documentation without manual writing. The mapping process automatically produces TESTING.md and INTEGRATIONS.md by analyzing your codebase and applying standard templates to capture the required context.

What specific files are created when mapping a repository for architectural clarity?

When mapping a repository for architectural clarity, the process creates seven specific files: STACK.md, INTEGRATIONS.md, ARCHITECTURE.md, STRUCTURE.md, CONVENTIONS.md, TESTING.md, and CONCERNS.md, all stored within the .planning/codebase/ directory.

Does codebase mapping require any specific dependencies or components to run?

Codebase mapping requires no specific dependencies or external components to run. It operates directly on entire repositories, using internal parallel agents and standard templates to write the seven planning documents to your local directory.