deepinit

Generate hierarchical AGENTS.md documentation with parent references across repository directories.

Updated Apr 11, 2026
One-click install
npx skills add https://github.com/Pryma-Tech/iris --skill deepinit-pryma-tech
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: deepinit
Source: https://github.com/Pryma-Tech/iris/tree/main/cli/skills/deepinit
Command: npx skills add https://github.com/Pryma-Tech/iris --skill deepinit-pryma-tech

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

AGENTS.md files act as AI-readable documentation for codebases, and this skill automates creating and maintaining a hierarchical AGENTS.md structure across a repository to improve navigation and agent guidance.

Core Features & Use Cases

  • Automatically generates AGENTS.md for directories with accurate parent references (<!-- Parent: --> tags).
  • Produces structured templates guiding AI agents on working in each directory, including the testing requirements and dependencies.
  • Use Case: In large monorepos, rapidly scaffold and synchronize documentation across all folders to ensure consistent agent guidance and traceability.

Quick Start

Run the deepinit skill to automatically scaffold hierarchical AGENTS.md documents across your repository

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 across a codebase?

To generate hierarchical AGENTS.md documentation, map the repository structure and apply a consistent template to each directory with correct parent references. This outputs updated files with timestamps, a dependency manifest, and a validation checklist.

What is an AGENTS.md file used for in a repository?

An AGENTS.md file acts as AI-readable documentation for codebases, providing structured guidance to AI agents on working within each directory. It includes testing requirements, dependencies, and parent references for navigation.

Can I regenerate auto-generated sections in AGENTS.md without overwriting manual notes?

Yes, you can regenerate only auto-generated sections while preserving manual notes. The process updates timestamps and auto-generated content but leaves manually added notes intact to maintain your custom documentation.

Does this approach work for scaffolding documentation in large monorepos?

Yes, this approach is designed for large monorepos to rapidly scaffold and synchronize documentation across all folders. It ensures consistent AI agent guidance and traceability through accurate parent references and a validation checklist.

How do I ensure hierarchy integrity when maintaining AGENTS.md files?

To ensure hierarchy integrity, the output includes a validation checklist and correct parent reference tags. This verifies that the parent-child relationships between directories remain accurate after regeneration.

What is the best way to automate AI agent guidance documentation in markdown?

The best way to automate AI agent guidance is to map directories requiring documentation and apply a consistent markdown template. This produces structured files guiding agents with testing requirements and dependencies across the hierarchy.