deepinit

Generate hierarchical AGENTS.md files for each directory in a codebase.

2|Updated Jan 29, 2026
One-click install
npx skills add https://github.com/mikev10/olympus --skill deepinit-mikev10
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: deepinit
Source: https://github.com/mikev10/olympus/tree/main/resources/skills/deepinit
Command: npx skills add https://github.com/mikev10/olympus --skill deepinit-mikev10

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation and maintenance of comprehensive documentation for an entire codebase by generating hierarchical AGENTS.md files for every directory.

Core Features & Use Cases

  • Recursive Codebase Indexing: Analyzes all directories and subdirectories.
  • Automated Documentation Generation: Creates AGENTS.md files describing each directory's purpose, contents, and AI agent instructions.
  • Hierarchical Structure: Ensures documentation links parent and child directories.
  • Smart Updates: Merges new discoveries with existing documentation, preserving manual annotations.
  • Use Case: Onboarding new developers by providing a clear, structured overview of the entire project's architecture and the role of each module.

Quick Start

Run the deepinit skill to initialize the current directory and all its subdirectories with AGENTS.md files.

Frequently Asked Questions about deepinit

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

FAQPage Schema
How do I automatically generate documentation for my entire codebase directory structure?

To generate hierarchical codebase documentation, you run a recursive initialization process that analyzes directories and creates AGENTS.md files describing each folder's purpose, contents, and AI agent instructions.

What are hierarchical AGENTS.md files and how do they work for codebase indexing?

Hierarchical AGENTS.md files are automated documentation records that link parent and child directories, providing a structured overview of a project's architecture and the specific role of each module for onboarding.

Can I update existing codebase documentation without losing my manual annotations?

Yes, you can update existing codebase documentation using smart update modes that merge new structural discoveries with existing files, ensuring your manual annotations are preserved during the indexing process.

Does the documentation generation tool support a dry-run mode to preview changes?

Yes, the documentation generation tool supports a dry-run mode that allows you to efficiently preview the recursive directory analysis and AGENTS.md file creation before applying any actual changes to your codebase.

What is the best way to document a large codebase for new developer onboarding?

The best way to document a large codebase for onboarding is recursive hierarchical indexing, which analyzes all subdirectories and generates structured AGENTS.md files to clarify the project architecture and module roles.