Build Workspace Docs

Rigenera README.md e WORK_AREAS.md in un workspace di libreria ai-agent-skills tramite la CLI.

di MoizIbnYousaf · MoizIbnYousaf/Ai-Agent-Skills

Richiede configurazione ★ 6.8/10

Build Workspace Docs — Rigenera README.md e WORK_AREAS.md in un workspace di libreria ai-agent-skills tramite la CLI.

Cosa fa

Avvolge il comando `build-docs` della CLI `ai-agent-skills` per rigenerare i file README.md e WORK_AREAS.md di un workspace di libreria di skill gestito da skills.json, in modo che le tabelle degli scaffali, i conteggi delle skill e le tabelle delle sorgenti corrispondano al catalogo. Si attiva quando un utente chiede di ricostruire o risincronizzare la documentazione generata di un workspace di libreria ai-agent-skills dopo aver aggiunto, importato o curato le skill. Richiede Node/npx e un workspace inizializzato contenente .ai-agent-skills/config.json.

Rapporto di test

Ho costruito un vero workspace in una HOME temporanea (`npx ai-agent-skills@4.3.2 init-library demo-lib --areas "frontend,workflow"`, importato due skill 'house-copy', quindi aggiunto una terza voce di catalogo a skills.json per rendere la documentazione obsoleta), l'ho copiato due volte e ho prodotto due artefatti: una baseline dove ho modificato manualmente README.md/WORK_AREAS.md, e un artefatto della skill dal flusso CLI prescritto. La documentazione generata differiva dalla mia modifica manuale su due righe derivate — statistiche README "3 house copies · 0 cataloged upstream" vs le mie "2 house copies · 1 cataloged upstream", e cella sorgente WORK_AREAS "workspace" vs la mia "upstream/seo-pack" — cioè, la CLI ha derivato correttamente tier/author da skills.json dove io avevo sbagliato, e una seconda esecuzione era byte-identica (idempotente). Tuttavia, i passaggi 1 e 3 della skill (`build-docs --dry-run`, e `--dry-run --format json`) sono entrambi usciti con codice 1 con "ENOENT ... /opt/homebrew/lib/node_modules/ai-agent-skills/WORK_AREAS.md"; il tarball 4.3.2 pubblicato non contiene WORK_AREAS.md (escluso da .npmignore e package.json files[]), e cli.js:6846 passa il contesto del workspace come oggetto options, quindi `generatedDocsAreInSync` ricade sulla radice del pacchetto in bundle. Forzando l'esecuzione contro una copia del pacchetto patchata, il campo `currentlyInSync` documentato confrontava con il README del repo upstream invece che con il workspace, riportando readmeMatches:false subito dopo una rigenerazione riuscita. Il frontmatter ha name+description, nessun script o file in bundle è referenziato, e non ho trovato vulnerabilità di sicurezza (nessun curl|sh, base64, accesso a credenziali o testo di iniezione) nel SKILL.md di 52 righe.

Testato il: 2026-07-21 · Claude Code 2.x (agent harness)

Installazione

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.

Comandi e prompt di esempio

  • /build-workspace-docsRigenera README.md e WORK_AREAS.md in un workspace di libreria ai-agent-skills tramite la CLI.

Gli skill si attivano con richieste in linguaggio naturale, senza comandi da ricordare. Dopo l'installazione, prompt come questi lo attivano (in inglese):

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