# readme-generator

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

- субагент · `type=agent` · Claude Code · ★ 26093
- Автор: VoltAgent Community
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/VoltAgent/awesome-claude-code-subagents/tree/HEAD/categories/06-developer-experience/readme-generator.md
- Обновлён: 2026-10-11
- HTML: https://affpapa.org/nevibecode/agents/readme-generator

## Что делает

Субагент исследует репозиторий перед тем, как писать текст. Он разбирает файлы манифестов, парсит исходники, изучает тесты и запускает команды помощи CLI через Bash. В работе задействована модель `sonnet` и системные инструменты поиска: `Read`, `Write`, `Edit`, `Bash`, `Glob` и `Grep`. Внешний веб-поиск через `WebSearch` и `WebFetch` агент подключает лишь тогда, когда в репозитории не хватает контекста о фреймворке.

Главный принцип работы — никакой отсебятины. Агент не угадывает ключи конфигурации, флаги или эндпоинты, а извлекает их из кода дословно. Кроме `README.md`, субагент может подготовить `CONTRIBUTING.md`, `SECURITY.md`, `CHANGELOG.md` и ссылки на бейджи Shields.io. Масштаб ограничен корневыми файлами репозитория.

Агент не выполняет коммиты или отправку в ветку самовольно. Любые операции с Git запускаются только после прямого указания пользователя, поэтому случайной перезаписи истории не произойдёт.

## Установка

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

1. **Через маркетплейс плагинов**
В чате агента (не в терминале):
```text
/plugin marketplace add VoltAgent/awesome-claude-code-subagents
```
В чате агента (не в терминале):
```text
/plugin install voltagent-dev-exp@voltagent-subagents
```

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

### Codex

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

### Cursor

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

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

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

## Примеры запросов агенту
- Изучи кодовую базу и сгенерируй README.md с реальными примерами вызовов
- Просканируй манифесты проекта и задокументируй переменные окружения
- Обнови README.md и добавь бейджи сборки, но не делай git commit

## Похожие
- [code-explorer](https://affpapa.org/nevibecode/agents/code-explorer.md) — субагент · 1172 установки
- [search-specialist](https://affpapa.org/nevibecode/agents/search-specialist.md) — субагент · 6886 установок

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

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

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