К основному содержанию
скилл CX Codex

update-readme — скилл для Claude Code: обновление README по коду и git

Скилл update-readme для Claude Code обновляет существующий README.md по текущему состоянию кода, истории git и CHANGELOG. Обновляет документацию, сверяя её с проектом.

лицензия не указана ★ 276 обновлён 2026-10-29

Установить в Claude Code · Через маркетплейс плагинов Все способы и платформы ↓
/plugin marketplace add gupsammy/Claudest
/plugin install claude-coding@Claudest
Открыть на GitHub

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

Скилл проходит по существующему README.md по шагам, а не пишет файл заново. Сначала вызывает claude-coding:make-changelog, чтобы CHANGELOG.md догнал текущую версию, потом запускает три субагента Explore одним сообщением: один проверяет каждый заголовок на устаревшие версии, битые пути и незаполненные плейсхолдеры, второй читает манифест и структуру каталогов, третий собирает коммиты после последнего изменения README.

Правки идут по приоритету: сначала версии и бейджи shields.io, затем устаревшие пути и команды, потом плейсхолдеры, новые фичи из коммитов и CHANGELOG, и в конце недостающие разделы вроде установки или API. Мелкие правки вносятся через Edit, чтобы не терять git blame; Write применяется, только если меняется больше 60% файла. В конце печатается сводка: сколько было строк и сколько стало, какие разделы тронуты, поднялась ли версия.

Без git-истории make-changelog вернёт ошибку, и обновление пойдёт дальше без контекста changelog — раздел с фичами тогда опирается только на сканирование кода. Если README нет или в нём меньше 5 строк реального текста, скилл передаёт работу claude-coding:make-readme и на этом останавливается.

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

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

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

  • Обнови README, он разошёлся с кодом
  • Синхронизируй README с кодовой базой и историей git
  • README устарел, поправь разделы и версию

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

1Через маркетплейс плагинов

/plugin marketplace add gupsammy/Claudest
/plugin install claude-coding@Claudest

Команда ставит плагин claude-coding целиком, со всеми его скиллами

2Через Skills CLI (Vercel)

npx skills add gupsammy/Claudest --skill update-readme -a claude-code

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

~/.claude/skills/update-readme/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/update-readme/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы об update-readme

Как установить update-readme в Claude Code?

Через маркетплейс: сначала /plugin marketplace add gupsammy/Claudest, затем /plugin install claude-coding@Claudest.

Что делает update-readme?

Освежает существующий README.md: правит версии, пути и плейсхолдеры, дописывает недостающие разделы, опираясь на код, git-историю и CHANGELOG.md.

Нужна ли git-история для работы скилла?

Да. Без неё make-changelog вернёт ошибку, и скилл продолжит без данных changelog: раздел с фичами будет собран только по коду.

Похожие скиллы

Все скиллы по теме «Тексты и документация» →
readme-generator VoltAgent Community Субагент readme-generator для Claude Code сканирует кодовую базу, тесты и манифесты и собирает README без выдуманных параметров. Включается для проектов без понятного README. CX Codex ★ 26 718звёзд репо readme-updater alirezarezvani Скилл readme-updater обновляет README автоматически, когда меняется структура проекта, добавляются зависимости или новые фичи. CX Codex +1 ★ 788звёзд репо 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установок docs-updater giuseppe-trisciuoglio Скилл docs-updater для Claude Code анализирует изменения Git и обновляет документацию проекта. Запускается при подготовке релиза, синхронизации README или перед pull request. CX Codex +1 3 700установок update-docs-on-code-change официальный github Правило update-docs-on-code-change для GitHub Copilot, которое обновляет README.md и другие файлы документации при изменении кода. Срабатывает, когда новые функции, изменения API или зависимостей требуют правок в описаниях. CX Codex +1 ★ 41 430звёзд репо

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

Весь набор →
memory-auditor Субагент memory-auditor сверяет записи памяти с кодом и историей Git, отмечает устаревшие факты и записи, которые стоит объединить или удалить. Запускайте после крупных изменений проекта. CX Codex ★ 276звёзд репо clean-branches Скилл clean-branches для Claude Code находит слитые и устаревшие ветки в git-репозитории, показывает кандидатов и защищённые ветки. Перед удалением запрашивает подтверждение. CX Codex +1 ★ 276звёзд репо council Скилл council запускает совет субагентов с разными ролями, изучает файлы репозитория и выносит чёткий вердикт по архитектурным или стратегическим вопросам. CX Codex +1 ★ 276звёзд репо claw-advisor Скилл claw-advisor для Claude Code отвечает на вопросы о настройке OpenClaw, диагностике и архитектуре. Он подключается к запросам о каналах, шлюзе, моделях и автоматизации. CX Codex +1 ★ 276звёзд репо architecture-auditor Субагент architecture-auditor оценивает архитектуру проекта, ищет циклические зависимости и даёт советы по выбору паттернов при изменении нескольких модулей. CX Codex ★ 276звёзд репо make-changelog Скилл make-changelog создаёт или дополняет CHANGELOG.md по истории Git в формате Keep a Changelog. Пригодится перед выпуском версии или когда записи в журнале устарели. CX Codex +1 ★ 276звёзд репо recall-conversations Скилл recall-conversations для Claude: перечитывает прошлые сессии, находит нужное решение, восстанавливает контекст и собирает ретроспективы по локальной базе переписки. CX Codex +1 ★ 276звёзд репо make-readme Скилл make-readme сканирует проект, задаёт уточняющие вопросы и сразу собирает файл README.md с бейджами и нужной структурой. CX Codex +1 ★ 276звёзд репо

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

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