build-workspace-docs — скилл для Claude Code: что делает и установка
Скилл build-workspace-docs синхронизирует README.md и WORK_AREAS.md с каталогом скиллов. Нужен после изменений в библиотеке или перед коммитом.
MIT 172 установок ★ 1 161 обновлён 2026-09-21
npx skills add MoizIbnYousaf/ai-agent-skills --skill build-workspace-docs -a claude-codeЧто делает build-workspace-docs
Скилл обновляет сгенерированные разделы README.md и WORK_AREAS.md в рабочем пространстве библиотеки. Сначала он запускает просмотр изменений через --dry-run, затем пересобирает документы командой build-docs. Результат можно получить в JSON для автоматизированного пайплайна.
Работать нужно из инициализированного рабочего пространства с файлом .ai-agent-skills/config.json. Без этого файла команда завершится ошибкой. Сгенерированные секции нельзя править вручную: их границы задают HTML-комментарии <!-- GENERATED:...:start/end -->. Проверку актуальности docs даёт поле currentlyInSync в JSON-выводе.
Какие задачи решает
- синхронизировать README.md с каталогом скиллов
- пересобрать WORK_AREAS.md после добавления скиллов
- просмотреть изменения перед записью документов
- проверить актуальность документации в JSON
- подготовить docs перед коммитом в git
Примеры запросов агенту
- Проверь, что изменится в документации рабочего пространства, через
build-docs --dry-run. - Пересобери
README.mdиWORK_AREAS.mdпосле изменения каталога скиллов. - Проверь результат в JSON и сообщи значение
currentlyInSync.
Как установить build-workspace-docs
1Через Skills CLI (Vercel)
npx skills add MoizIbnYousaf/ai-agent-skills --skill build-workspace-docs -a claude-code2Вручную: положить файлы
~/.claude/skills/build-workspace-docs/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/build-workspace-docs/
1Через Skills CLI (Vercel)
npx skills add MoizIbnYousaf/ai-agent-skills --skill build-workspace-docs -a codex2Вручную: положить файлы
.agents/skills/build-workspace-docs/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add MoizIbnYousaf/ai-agent-skills --skill build-workspace-docs -a cursor2Вручную: положить файлы
.cursor/skills/build-workspace-docs/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install MoizIbnYousaf/ai-agent-skills skills/build-workspace-docs2Вручную: положить файлы
.github/skills/build-workspace-docs/SKILL.md1Через Skills CLI (Vercel)
npx skills add MoizIbnYousaf/ai-agent-skills --skill build-workspace-docs -a gemini-cli2Командой платформы
gemini skills install https://github.com/MoizIbnYousaf/ai-agent-skills --path skills/build-workspace-docsВручную: положить файлы
.devin/skills/build-workspace-docs/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add MoizIbnYousaf/ai-agent-skills --skill build-workspace-docs -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы о build-workspace-docs
Как установить build-workspace-docs в Claude Code?
Выполните npx skills add MoizIbnYousaf/ai-agent-skills --skill build-workspace-docs -a claude-code. Скилл появится по пути ~/.claude/skills/build-workspace-docs/SKILL.md.
Что делает build-workspace-docs?
Он синхронизирует README.md и WORK_AREAS.md с каталогом скиллов: сначала показывает план изменений, затем пересобирает документы и может вернуть структурированный JSON.
Где запускать build-workspace-docs?
Только внутри инициализированного рабочего пространства с .ai-agent-skills/config.json. Сначала используйте --dry-run, а сгенерированные секции не редактируйте вручную.
Исходный текст
SKILL.md · MIT
--- name: build-workspace-docs description: Use when regenerating README.md and WORK_AREAS.md in a managed library workspace. Always dry-run first to preview changes. category: workflow version: 4.1.0 --- # Build Workspace Docs ## Goal Keep workspace documentation in sync with the skills catalog after adding, removing, or curating skills. ## Guardrails - Always use `--dry-run` before regenerating docs to preview what will change. - Only run from inside an initialized library workspace (a directory with `.ai-agent-skills/config.json`). - Never hand-edit the generated sections of README.md or WORK_AREAS.md. The CLI will overwrite them. - Use `--format json` to capture structured results for automation pipelines. ## Workflow 1. Preview what would change. ```bash npx ai-agent-skills build-docs --dry-run ``` 2. Regenerate the docs. ```bash npx ai-agent-skills build-docs ``` 3. Verify the output. ```bash npx ai-agent-skills build-docs --dry-run --format json ``` The JSON output includes `currentlyInSync` to tell you whether docs were already up to date. ## When to Run - After `add`, `catalog`, `vendor`, or `curate` commands that change the skills catalog. - After bulk imports from a remote library. - Before committing workspace changes to git. ## Gotchas - Running outside a workspace will fail with a clear error. Use `init-library` to create one first. - The generated docs use HTML comment markers (`<!-- GENERATED:...:start/end -->`) as boundaries. Do not remove these markers from the template sections.
© MoizIbnYousaf · MIT · MoizIbnYousaf/ai-agent-skills