# readme-generator

Субагент readme-generator для Codex собирает README по реальным файлам репозитория и проверяет команды, настройки и примеры. Готовит документацию без выдуманных инструкций.

- субагент · `type=agent` · Codex, Claude Code, Cursor · ★ 6505 у репозитория
- Автор: VoltAgent
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/VoltAgent/awesome-codex-subagents/tree/HEAD/categories/06-developer-experience/readme-generator.toml
- Обновлён: 2026-10-05
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/agents/voltagent-readme-generator

## Что делает

readme-generator изучает манифесты, скрипты, тесты, определения типов и точки входа, чтобы описать устройство проекта, установку, первый запуск и настройки. Примеры он берёт из тестов, примеров кода или вывода CLI, а внешние источники использует для контекста фреймворка.

Он также проверяет команды, флаги и переменные окружения по файлам проекта, сверяет примеры и ссылки на бейджи с настроенными сервисами. Если подтверждения для раздела нет, субагент отмечает пробел, а не дополняет его догадкой. README остаётся в центре работы: сайт документации передаётся отдельному субагенту.

На выходе — готовый README, список просмотренных файлов с основаниями для нетривиальных утверждений, пробелы и дальнейшие шаги. Субагент не делает git commit или push без разрешения и не расширяет задачу до сайта документации без запроса.

## Установка

### Codex (родная платформа)

**Вручную: положить файлы**
- Файл: `.codex/agents/readme-generator.toml` — Codex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/

### Claude Code

**Вручную: положить файлы**
- Файл: `.claude/agents/readme-generator.md` — Для всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию

### Cursor

**Вручную: положить файлы**
- Файл: `.cursor/agents/readme-generator.md` — Cursor понимает и .claude/agents/

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/VoltAgent/awesome-codex-subagents/tree/HEAD/categories/06-developer-experience/readme-generator.toml

## Когда брать
- составить README по содержимому репозитория
- проверить команды установки и первого запуска
- сверить примеры и настройки с исходным кодом
- найти разделы документации без подтверждающих файлов

## Примеры запросов агенту
- Подготовь README для этого репозитория и проверь каждую команду по файлам проекта.
- Сверь примеры CLI и настройки в README с тестами, скриптами и манифестами.
- Составь README и перечисли файлы, на которых основаны важные утверждения.

## Похожие
- [create-readme](https://affpapa.org/nevibecode/skills/create-readme.md) — скилл · 19081 установка
- [readme-optimization](https://affpapa.org/nevibecode/skills/readme-optimization.md) — скилл · 13600 установок
- [readme-blueprint-generator](https://affpapa.org/nevibecode/skills/readme-blueprint-generator.md) — скилл · 9662 установки
- [indexion-readme](https://affpapa.org/nevibecode/skills/indexion-readme.md) — скилл · 5100 установок
- [beautify-github-readme](https://affpapa.org/nevibecode/skills/beautify-github-readme.md) — скилл · 1300 установок
- [re0-readme](https://affpapa.org/nevibecode/skills/re0-readme.md) — скилл · 126 установок

## Другие версии с тем же именем
- [readme-generator · voltagent](https://affpapa.org/nevibecode/agents/readme-generator.md) — ★ 26718 у репозитория

Из того же набора: [voltagent/awesome-codex-subagents](https://affpapa.org/nevibecode/by/voltagent/awesome-codex-subagents.md) — 176 карточек

_Часть страницы не вошла по размеру — она есть в HTML-версии._

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md
