Build Workspace Docs

Regénère README.md et WORK_AREAS.md dans un espace de travail de bibliothèque ai-agent-skills via le CLI.

par MoizIbnYousaf · MoizIbnYousaf/Ai-Agent-Skills

Fonctionne avec configuration ★ 6.8/10

Build Workspace Docs — Regénère README.md et WORK_AREAS.md dans un espace de travail de bibliothèque ai-agent-skills via le CLI.

Ce que fait

Enveloppe la commande `build-docs` du CLI `ai-agent-skills` pour regénérer les fichiers README.md et WORK_AREAS.md d'un espace de travail de bibliothèque de compétences géré à partir de skills.json, afin que les tables d'étagères, les comptes de compétences et les tables sources correspondent au catalogue. Se déclenche lorsqu'un utilisateur demande de reconstruire ou de resynchroniser les documents générés d'un espace de travail de bibliothèque ai-agent-skills après avoir ajouté, importé ou organisé des compétences. Nécessite Node/npx et un espace de travail initialisé contenant .ai-agent-skills/config.json.

Rapport de test

Construit un espace de travail réel dans un HOME temporaire (`npx ai-agent-skills@4.3.2 init-library demo-lib --areas "frontend,workflow"`, importé deux compétences de copie locale, puis ajouté une troisième entrée de catalogue à skills.json pour rendre les docs obsolètes), copié deux fois, et produit deux artefacts : une référence où j'ai édité manuellement README.md/WORK_AREAS.md, et un artefact de compétence issu du flux CLI prescrit. Les docs générés différaient de mon édition manuelle sur deux lignes dérivées — statistiques README "3 house copies · 0 cataloged upstream" vs mes "2 house copies · 1 cataloged upstream", et cellule source WORK_AREAS "workspace" vs mon "upstream/seo-pack" — c'est-à-dire que le CLI a dérivé correctement le tier/auteur de skills.json là où j'avais mal deviné, et une deuxième exécution était identique au byte près (idempotente). Cependant, les étapes 1 et 3 de la compétence (`build-docs --dry-run`, et `--dry-run --format json`) ont toutes deux échoué avec "ENOENT ... /opt/homebrew/lib/node_modules/ai-agent-skills/WORK_AREAS.md" ; le tarball publié 4.3.2 ne contient pas de WORK_AREAS.md (exclu par .npmignore et package.json files[]), et cli.js:6846 passe le contexte de l'espace de travail comme objet d'options, donc `generatedDocsAreInSync` revient à la racine du package groupé. Le forcer à s'exécuter contre une copie de package patchée a montré le champ `currentlyInSync` documenté se comparant au propre README du dépôt upstream au lieu de l'espace de travail, rapportant readmeMatches:false juste après une régénération réussie. Le frontmatter a name+description, aucun script ou fichier groupé n'est référencé, et je n'ai trouvé aucune faille de sécurité (pas de curl|sh, base64, accès aux identifiants, ou texte d'injection) dans le SKILL.md de 52 lignes.

Testé le: 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.

Commandes et exemples de prompts

  • /build-workspace-docsRegénère README.md et WORK_AREAS.md dans un espace de travail de bibliothèque ai-agent-skills via le CLI.

Les skills se déclenchent sur des demandes en langage courant — aucune commande à retenir. Après installation, des prompts comme ceux-ci l'activent (en anglais) :

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