Build Workspace Docs

Regenererar README.md och WORK_AREAS.md i en ai-agent-skills biblioteksarbetsyta via CLI

av MoizIbnYousaf · MoizIbnYousaf/Ai-Agent-Skills

Fungerar med konfiguration ★ 6.8/10

Build Workspace Docs — Regenererar README.md och WORK_AREAS.md i en ai-agent-skills biblioteksarbetsyta via CLI

Vad den gör

Kapslar in `ai-agent-skills` CLI-kommandot `build-docs` för att regenerera README.md- och WORK_AREAS.md-filerna i en hanterad skills-library-arbetsyta från skills.json, så att hylltabeller, färdighetsantal och källtabeller matchar katalogen. Utlöses när en användare ber att bygga om eller synkronisera de genererade dokumenten för en ai-agent-skills biblioteksarbetsyta efter att ha lagt till, importerat eller kurerat färdigheter. Kräver Node/npx och en initierad arbetsyta som innehåller .ai-agent-skills/config.json.

Testrapport

Byggde en riktig arbetsyta i en temporär HOME (`npx ai-agent-skills@4.3.2 init-library demo-lib --areas "frontend,workflow"`, importerade två house-copy-färdigheter, lade sedan till en tredje katalogpost i skills.json för att göra dokumenten inaktuella), kopierade den två gånger och producerade två artefakter: en baslinje där jag handredigerade README.md/WORK_AREAS.md, och en färdighetsartefakt från det föreskrivna CLI-flödet. De genererade dokumenten skilde sig från min handredigering på två härledda rader — README-statistik "3 house copies · 0 cataloged upstream" kontra mina "2 house copies · 1 cataloged upstream", och WORK_AREAS källcell "workspace" kontra mina "upstream/seo-pack" — dvs. CLI härledde tier/author korrekt från skills.json där jag gissade fel, och en andra körning var byte-identisk (idempotent). Dock avslutades steg 1 och 3 av färdigheten (`build-docs --dry-run`, och `--dry-run --format json`) båda med 1 med "ENOENT ... /opt/homebrew/lib/node_modules/ai-agent-skills/WORK_AREAS.md"; den publicerade 4.3.2 tarballen innehåller ingen WORK_AREAS.md (exkluderad av .npmignore och package.json files[]), och cli.js:6846 skickar arbetsytans kontext som options-objektet så `generatedDocsAreInSync` faller tillbaka till den medföljande paketroten. Att tvinga den att köras mot en patchad paketkopia visade att det dokumenterade `currentlyInSync`-fältet jämfördes mot uppströmsrepots egen README istället för arbetsytan, och rapporterade readmeMatches:false direkt efter en lyckad regenerering. Frontmatter har name+description, inga skript eller medföljande filer refereras, och jag hittade inga säkerhetsbrister (ingen curl|sh, base64, åtkomst till autentiseringsuppgifter eller injektionstext) i den 52-radiga SKILL.md.

Testad: 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.

Kommandon och exempelprompter

/build-workspace-docsRegenererar README.md och WORK_AREAS.md i en ai-agent-skills biblioteksarbetsyta via CLI

Skills triggas av vanliga förfrågningar — inga kommandon att memorera. Efter installationen aktiverar prompter som dessa skillen (på engelska):

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

Läs hela rapporten →