agents-md-generator

Generate hierarchical AGENTS.md files for codebases with templates.

Updated Jul 8, 2022

Search Tags:#automation #documentation #AI agents #codebase #hierarchy #AGENTS.md

Ready to run

npx skills add https://github.com/limaon/dotfiles --skill agents-md-generator-limaon

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: agents-md-generator
Source: https://github.com/limaon/dotfiles/tree/main/.config/opencode/skills/agents-md-generator
Command: npx skills add https://github.com/limaon/dotfiles --skill agents-md-generator-limaon

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates hierarchical AGENTS.md structures for codebases, enabling lightweight root guidance with targeted sub-files to accelerate AI-assisted documentation and agent-driven workflows.

Core Features & Use Cases

Phase-based generation: root AGENTS.md with links to sub-files, plus per-folder AGENTS.md when needed
JIT indexing: concise, path-specific hints to guide discovery and quick navigation
Templates: starter root file and per-package templates for monorepos, multi-package projects, and single repos

Quick Start

Instruct the generator to create root and per-folder AGENTS.md files for your repository and tailor them to your project structure.

Frequently Asked Questions about agents-md-generator

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

FAQPage Schema

How do I generate hierarchical AGENTS.md files for a monorepo?▼

To generate hierarchical AGENTS.md files for a monorepo, apply a four-phase workflow that analyzes the repository, creates a root AGENTS.md with links, and generates sub-folder files for targeted AI agent guidance.

What is the best way to structure AI-friendly documentation for a complex codebase?▼

Structuring AI-friendly documentation for a complex codebase is best achieved by creating hierarchical AGENTS.md files, providing lightweight root guidance with targeted sub-files to accelerate agent-driven workflows.

Can I use this to create per-folder AGENTS.md files for multi-package projects?▼

Yes, you can create per-folder AGENTS.md files for multi-package projects using starter root file and per-package templates, ensuring path-specific hints guide discovery and quick navigation across your codebase.

Do I need a specific framework to build AGENTS.md files for my repository?▼

No specific framework is required to build AGENTS.md files for your repository; the generator applies template-based customization to analyze the codebase structure and output copy-ready guidance for AI agents.

When should I generate sub-folder AGENTS.md files instead of a single root file?▼

You should generate sub-folder AGENTS.md files instead of a single root file when managing monorepos or multi-package projects that need concise, path-specific hints to guide AI agent discovery and navigation.