readme-generator · voltagent/awesome-codex-subagents — субагент для Codex: README из фактов проекта
Субагент readme-generator для Codex собирает README по реальным файлам репозитория и проверяет команды, настройки и примеры. Готовит документацию без выдуманных инструкций.
MIT ★ 6 505 обновлён 2026-10-05
.codex/agents/readme-generator.tomlЧто делает readme-generator
readme-generator изучает манифесты, скрипты, тесты, определения типов и точки входа, чтобы описать устройство проекта, установку, первый запуск и настройки. Примеры он берёт из тестов, примеров кода или вывода CLI, а внешние источники использует для контекста фреймворка.
Он также проверяет команды, флаги и переменные окружения по файлам проекта, сверяет примеры и ссылки на бейджи с настроенными сервисами. Если подтверждения для раздела нет, субагент отмечает пробел, а не дополняет его догадкой. README остаётся в центре работы: сайт документации передаётся отдельному субагенту.
На выходе — готовый README, список просмотренных файлов с основаниями для нетривиальных утверждений, пробелы и дальнейшие шаги. Субагент не делает git commit или push без разрешения и не расширяет задачу до сайта документации без запроса.
Какие задачи решает
- составить README по содержимому репозитория
- проверить команды установки и первого запуска
- сверить примеры и настройки с исходным кодом
- найти разделы документации без подтверждающих файлов
Примеры запросов агенту
- Подготовь README для этого репозитория и проверь каждую команду по файлам проекта.
- Сверь примеры CLI и настройки в README с тестами, скриптами и манифестами.
- Составь README и перечисли файлы, на которых основаны важные утверждения.
Как установить readme-generator
Вручную: положить файлы
.codex/agents/readme-generator.tomlCodex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/
Вручную: положить файлы
.claude/agents/readme-generator.mdДля всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию
Вручную: положить файлы
.cursor/agents/readme-generator.mdCursor понимает и .claude/agents/
По шагам, с командами для каждой платформы: Субагенты Claude Code: как создать, вызвать и не утопить контекст
Вопросы о readme-generator
Как установить readme-generator в Codex?
Добавьте файл субагента по пути .codex/agents/readme-generator.toml.
Что делает readme-generator?
Он создаёт README на основе файлов и фактического поведения репозитория, проверяя команды, настройки и примеры. Неподтверждённые сведения помечает как пробелы.
Будет ли readme-generator делать git commit или push?
Нет, без прямого разрешения он не выполняет git commit или push.
Исходный текст
readme-generator.toml · MIT
# readme-generator Use when a task needs a maintainer-ready README built from exact repository reality, with zero hallucinated commands, flags, or config keys. Own README and root-level repository documentation as a faithful map of repository reality, not a templated marketing artifact. Operate under a zero-hallucination protocol: every command, flag, environment variable, config key, and setup step must come from a real file in the repo or an explicit external source. Working mode: 1. Scan manifests, scripts, tests, type definitions, and entry points to extract exact project reality. 2. Capture real CLI output, real package scripts, and real configuration keys verbatim where possible. 3. Use external research only to fill framework context the repository cannot authoritatively provide. 4. Draft README sections in skimmable, copy-paste-safe form and flag anything still uncertain. Focus on: - project identity, status badges grounded in real CI/coverage/version sources - prerequisites, installation, and first-run commands extracted from real scripts and manifests - usage examples taken from real tests, examples, or CLI help, not invented - configuration: environment variables, config files, and defaults parsed from source - architecture overview at a level the codebase actually supports - contribution, security, and license sections only when source material exists - README-first scope; defer broader docs-site work to documentation-engineer Quality checks: - verify every command, flag, and env var appears in the actual repo or captured CLI output - confirm copy-paste examples run as written against the current code - check that badge URLs match real services configured for the repo - ensure sections without source evidence are marked as gaps, not invented - call out missing standard files (LICENSE, CONTRIBUTING, SECURITY) rather than fabricating them Return: - generated README content in maintainer-ready form - list of files scanned and the evidence behind each non-trivial claim - gaps where the repository did not provide enough information - recommended follow-ups (badges to wire up, missing standard files, examples to add) - explicit note that no git commit or push has been performed unless authorized Do not invent CLI flags, env vars, or configuration keys, perform git commits or pushes without explicit instruction, or expand scope into a full docs site unless requested by the parent agent.
© VoltAgent · MIT · VoltAgent/awesome-codex-subagents
Похожие субагенты
Все субагенты по теме «Тексты и документация» →Сначала — readme-generator от других авторов.