agents-md-generator

Generate root and per-package AGENTS.md templates for repository submodules.

141|20|Updated Dec 19, 2025

Search Tags:#documentation #codebase #ai #agents #generate #AGENTS.md

Ready to run

npx skills add https://github.com/julianromli/opencode-template --skill agents-md-generator-julianromli

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This YAML-based tool analyzes repositories to determine where AGENTS.md files should live and how they should reference submodules, enabling scalable, consistent AI agent documentation across large codebases.

Core Features & Use Cases

Lightweight root AGENTS.md that links to sub-folders and references, keeping the top-level file concise.
Per-package AGENTS.md templates for apps (web/api), packages (ui/shared), services (auth/transcribe), and workers, enabling focused guidance per domain.
JIT indexing hints and path graphs to accelerate discovery and incremental documentation updates.

Quick Start

Run the generator to scaffold root and per-package AGENTS.md templates across your repository.

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 AGENTS.md documentation for a large codebase?▼

To generate AGENTS.md documentation for a large codebase, you can use a tool that analyzes your repository structure to determine file placement and references. It scaffolds a lightweight root file plus per-package templates.

What is the best way to structure AGENTS.md files for monorepo submodules?▼

The best way to structure AGENTS.md files for monorepo submodules is to use a concise root file that links to sub-folders, alongside focused per-package templates for apps, packages, services, and workers.

How do I create per-package AI agent guidance for different services?▼

You create per-package AI agent guidance for different services by generating customized AGENTS.md templates tailored to each domain, such as web apps, APIs, shared UI packages, and auth services.

Can I accelerate AI agent discovery and incremental documentation updates in my repository?▼

You can accelerate AI agent discovery and incremental documentation updates by incorporating JIT indexing hints and path graphs into your generated AGENTS.md files.

Does this approach work for scaffolding documentation across web and API directories?▼

Yes, this approach works for scaffolding documentation across web and API directories by analyzing your repository scope and generating ready-to-paste AGENTS.md templates with precise search hints for each directory level.