One-click install
npx skills add https://github.com/realsigridjin/oh-my-codex --skill deepinit-realsigridjin
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: deepinit
Source: https://github.com/realsigridjin/oh-my-codex/tree/main/skills/deepinit
Command: npx skills add https://github.com/realsigridjin/oh-my-codex --skill deepinit-realsigridjin

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the burden of manually documenting complex codebases by creating and maintaining hierarchical AGENTS.md files that give AI agents clear, directory-specific context.

Core Features & Use Cases

  • Codebase Mapping: Recursively analyze directories while excluding generated, dependency, and build artifacts.
  • Hierarchical Documentation: Generate parent-linked AGENTS.md files with purposes, key files, subdirectories, dependencies, testing guidance, and agent instructions.
  • Safe Updates and Validation: Preserve manual notes, refresh generated content, validate parent references, detect orphaned files, and handle empty directories appropriately.
  • Use Case: Initialize an unfamiliar repository with navigable documentation so delegated agents can understand local conventions, dependencies, and testing requirements before modifying files.

Quick Start

Use the deepinit skill to analyze this repository and generate or update comprehensive hierarchical AGENTS.md documentation while preserving manual notes.

Frequently Asked Questions about deepinit

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

FAQPage Schema
How do I generate hierarchical AGENTS.md documentation for my codebase?

Hierarchical AGENTS.md documentation is generated by recursively mapping repository directories, excluding build artifacts, and creating parent-linked files with purposes, key files, dependencies, and agent instructions.

What is AGENTS.md used for in codebase onboarding?

AGENTS.md is used for codebase onboarding to provide delegated AI agents with directory-specific context, local conventions, dependencies, and testing requirements before they modify unfamiliar project files.

Can I update repository documentation without losing manual notes?

You can update repository documentation while preserving manual notes by validating parent references, refreshing only generated content, detecting orphaned files, and handling empty or generated-file-only directories appropriately during the refresh.

Does deepinit handle empty or generated-file-only directories?

deepinit handles empty or generated-file-only directories through selective directory analysis, applying appropriate logic to skip build artifacts and manage directories that lack source files during the recursive mapping process.

What's the best way to initialize AI instructions for an unfamiliar repository?

The best way to initialize AI instructions for an unfamiliar repository is to perform recursive directory mapping and generate parent-first documentation hierarchies that outline purposes, subdirectories, and testing guidance for delegated agent workflows.

Why does codebase documentation need hierarchy validation?

Codebase documentation needs hierarchy validation to ensure parent references remain accurate after structural changes, preventing orphaned files and maintaining navigable documentation links across the directory tree.