Build Workspace Docs

Generiert README.md und WORK_AREAS.md in einem ai-agent-skills Bibliotheks-Workspace über die CLI neu

von MoizIbnYousaf · MoizIbnYousaf/Ai-Agent-Skills

Funktioniert mit Setup ★ 6.8/10

Build Workspace Docs — Generiert README.md und WORK_AREAS.md in einem ai-agent-skills Bibliotheks-Workspace über die CLI neu

Was es kann

Umschließt den `ai-agent-skills` CLI-Befehl `build-docs`, um die README.md- und WORK_AREAS.md-Dateien eines verwalteten Skills-Bibliotheks-Workspaces aus skills.json neu zu generieren, sodass Regal-Tabellen, Skill-Zählungen und Quelltabellen mit dem Katalog übereinstimmen. Wird ausgelöst, wenn ein Benutzer nach dem Hinzufügen, Importieren oder Kuratieren von Skills darum bittet, die generierten Dokumente eines ai-agent-skills Bibliotheks-Workspaces neu zu erstellen oder zu synchronisieren. Erfordert Node/npx und einen initialisierten Workspace, der .ai-agent-skills/config.json enthält.

Testbericht

Einen echten Workspace in einem temporären HOME erstellt (`npx ai-agent-skills@4.3.2 init-library demo-lib --areas "frontend,workflow"`, zwei House-Copy-Skills importiert, dann einen dritten Katalogeintrag zu skills.json hinzugefügt, um die Docs zu veralten), zweimal kopiert und zwei Artefakte erstellt: eine Baseline, bei der ich README.md/WORK_AREAS.md manuell bearbeitet habe, und ein Skill-Artefakt aus dem vorgeschriebenen CLI-Flow. Die generierten Docs unterschieden sich von meiner manuellen Bearbeitung in zwei abgeleiteten Zeilen – README-Statistiken „3 house copies · 0 cataloged upstream“ vs. meine „2 house copies · 1 cataloged upstream“, und WORK_AREAS-Quellzelle „workspace“ vs. meine „upstream/seo-pack“ – d.h. die CLI leitete Tier/Autor korrekt aus skills.json ab, wo ich falsch geraten hatte, und ein zweiter Lauf war byte-identisch (idempotent). Die Schritte 1 und 3 der Skill (`build-docs --dry-run` und `--dry-run --format json`) beendeten sich jedoch beide mit Exit-Code 1 und „ENOENT ... /opt/homebrew/lib/node_modules/ai-agent-skills/WORK_AREAS.md“; das veröffentlichte 4.3.2-Tarball enthält keine WORK_AREAS.md (ausgeschlossen durch .npmignore und package.json files[]), und cli.js:6846 übergibt den Workspace-Kontext als Options-Objekt, sodass `generatedDocsAreInSync` auf das gebündelte Paket-Root zurückfällt. Das Erzwingen der Ausführung gegen eine gepatchte Paketkopie zeigte, dass das dokumentierte `currentlyInSync`-Feld mit dem README des Upstream-Repos anstatt des Workspaces verglichen wurde und readmeMatches:false direkt nach einer erfolgreichen Regeneration meldete. Frontmatter hat name+description, es werden keine Skripte oder gebündelten Dateien referenziert, und ich fand keine Sicherheitsmängel (kein curl|sh, base64, Anmeldezugriff oder Injection-Text) in der 52-zeiligen SKILL.md.

Getestet am: 2026-07-21 · Claude Code 2.x (agent harness)

Installation

git clone --depth 1 https://github.com/MoizIbnYousaf/Ai-Agent-Skills.git /tmp/build-workspace-docs-src
mkdir -p ~/.claude/skills
cp -R /tmp/build-workspace-docs-src/skills/build-workspace-docs ~/.claude/skills/build-workspace-docs
# Runtime dependency (not stated in SKILL.md): Node.js + network for `npx ai-agent-skills`.
# Only usable inside a workspace created by: npx ai-agent-skills init-library <name>
# Alternative install via the project's own CLI: npx ai-agent-skills install build-workspace-docs
# KNOWN BREAKAGE (verified on ai-agent-skills@4.3.2): steps 1 and 3 of the skill body
#   (`build-docs --dry-run` and `build-docs --dry-run --format json`) exit 1 with
#   "ENOENT ... node_modules/ai-agent-skills/WORK_AREAS.md" because that file is
#   excluded from the published npm tarball. Run the bare `npx ai-agent-skills build-docs` instead.

Befehle & Beispiel-Prompts

  • /build-workspace-docsGeneriert README.md und WORK_AREAS.md in einem ai-agent-skills Bibliotheks-Workspace über die CLI neu

Skills reagieren auf normale Anfragen — keine Slash-Befehle nötig. Nach der Installation aktivieren Prompts wie diese den Skill (auf Englisch):

  • Regenerate the README for this workspace
  • Update WORK_AREAS.md to reflect current skills
  • Preview doc changes before regenerating them