К основному содержанию
субагент CX Codex

readme-generator · voltagent/awesome-codex-subagents — субагент для Codex: README из фактов проекта

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

MIT ★ 6 505 обновлён 2026-10-05

Установить в Codex · Вручную: положить файлы Все способы и платформы ↓
.codex/agents/readme-generator.toml
Открыть на GitHub

Что делает readme-generator

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

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

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

Какие задачи решает

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

Примеры запросов агенту

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

Как установить readme-generator

Вручную: положить файлы

.codex/agents/readme-generator.toml

Codex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/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 от других авторов.

readme-generator VoltAgent Community Субагент readme-generator для Claude Code сканирует кодовую базу, тесты и манифесты и собирает README без выдуманных параметров. Включается для проектов без понятного README. CX Codex ★ 26 718звёзд репо create-readme официальный github Скилл create-readme для GitHub Copilot изучает проект и создаёт структурированный README.md. Собирает документацию по коду и файлам проекта. CX Codex +1 19 081установок readme-optimization Samuel Berthe Скилл readme-optimization для Claude Code и Codex анализирует README репозитория и переписывает его в посадочную страницу для разработчиков. Он проверяет команды запуска по коду и отсекает лишние бейджи. CX Codex +1 13 600установок readme-blueprint-generator официальный github Скилл readme-blueprint-generator для GitHub Copilot собирает сведения из документации проекта и готовит структурированный README.md. Основа README — материалы из .github/copilot и copilot-instructions.md. CX Codex +1 9 662установок indexion-readme trkbt10 Скилл indexion-readme собирает README из шаблонов, doc-комментариев и статических файлов, а потом проверяет, что правки ничего не удалили. CX Codex +1 5 100установок beautify-github-readme oil-oil Скилл beautify-github-readme для Claude Code помогает переделать README GitHub или создать для него визуальные материалы. Он включается по просьбе оформить, упростить или проверить README. CX Codex +1 1 300установок re0-readme LilMGenius Скилл re0-readme для Claude Code проверяет и приводит в порядок README, AGENTS.md и файлы манифестов репозитория. Запускается перед написанием или ревизией документации. CX Codex +1 126установок

Из того же набора176

Весь набор →
visual-asset-generator Субагент visual-asset-generator генерирует иконки приложений, фавиконки, логотипы и OG-изображения под точные размеры проекта через MCP-сервер prompt-to-asset. CX Codex ★ 6 505звёзд репо tooling-engineer Субагент tooling-engineer помогает проектировать и проверять внутренние скрипты, автоматизацию и служебные команды. Подключайте его, когда рабочий процесс ломается на инструментах или окружении. CX Codex ★ 6 505звёзд репо slack-expert Субагент slack-expert для Codex помогает разрабатывать интеграции со Slack: ботов, обработчики событий и рабочие процессы. Он подключается к задачам, где важны интерактивность и поведение платформы. CX Codex ★ 6 505звёзд репо refactoring-specialist Субагент refactoring-specialist проводит низкорисковый структурный рефакторинг кода без изменения его поведения, улучшая читаемость и модульность. CX Codex ★ 6 505звёзд репо powershell-ui-architect Субагент powershell-ui-architect для Codex проектирует интерфейсы на PowerShell для терминалов, форм, WPF и административных инструментов. Разбирает сбои и неудобства в интерактивных сценариях. CX Codex ★ 6 505звёзд репо powershell-module-architect Субагент powershell-module-architect проектирует структуру модулей PowerShell, проверяет контракты команд Verb-Noun и организует упаковку без лишней переделки API. CX Codex ★ 6 505звёзд репо mcp-developer Субагент mcp-developer для Codex разбирает MCP-серверы и клиенты, схемы инструментов и интеграции. Проверяет совместимость протокола и обработку ошибок. CX Codex ★ 6 505звёзд репо legacy-modernizer Субагент legacy-modernizer для Codex планирует переход на современные технологии без потери функциональности. Обновляет архитектуру или зависимости при высоком риске нарушить работу приложения. CX Codex ★ 6 505звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой