Build Workspace Docs

Regenererer README.md og WORK_AREAS.md i et ai-agent-skills bibliotek-arbeidsområde via CLI

av MoizIbnYousaf · MoizIbnYousaf/Ai-Agent-Skills

Krever oppsett ★ 6.8/10

Build Workspace Docs — Regenererer README.md og WORK_AREAS.md i et ai-agent-skills bibliotek-arbeidsområde via CLI

Hva den gjør

Pakker `ai-agent-skills` CLI `build-docs`-kommandoen for å regenerere README.md- og WORK_AREAS.md-filene i et administrert ferdighetsbibliotek-arbeidsområde fra skills.json, slik at hylletabeller, ferdighetsteller og kildetabeller samsvarer med katalogen. Utløses når en bruker ber om å gjenoppbygge eller resynkronisere de genererte dokumentene i et ai-agent-skills bibliotek-arbeidsområde etter å ha lagt til, importert eller kuratert ferdigheter. Krever Node/npx og et initialisert arbeidsområde som inneholder .ai-agent-skills/config.json.

Testrapport

Bygde et ekte arbeidsområde i en midlertidig HOME (`npx ai-agent-skills@4.3.2 init-library demo-lib --areas "frontend,workflow"`, importerte to house-copy ferdigheter, deretter la til en tredje katalogoppføring i skills.json for å gjøre dokumentene utdaterte), kopierte det to ganger, og produserte to artefakter: en baseline der jeg håndredigerte README.md/WORK_AREAS.md, og en ferdighetsartefakt fra den foreskrevne CLI-flyten. De genererte dokumentene skilte seg fra min håndredigering på to avledede linjer — README-statistikk "3 house copies · 0 cataloged upstream" vs min "2 house copies · 1 cataloged upstream", og WORK_AREAS kildecelle "workspace" vs min "upstream/seo-pack" — dvs. CLI avledet tier/author korrekt fra skills.json der jeg gjettet feil, og en andre kjøring var byte-identisk (idempotent). Imidlertid, trinn 1 og 3 av ferdigheten (`build-docs --dry-run`, og `--dry-run --format json`) avsluttet begge med 1 og "ENOENT ... /opt/homebrew/lib/node_modules/ai-agent-skills/WORK_AREAS.md"; den publiserte 4.3.2 tarballen inneholder ingen WORK_AREAS.md (ekskludert av .npmignore og package.json files[]), og cli.js:6846 sender arbeidsområdekonteksten som options-objektet slik at `generatedDocsAreInSync` faller tilbake til den medfølgende pakkeroten. Ved å tvinge den til å kjøre mot en patchet pakke-kopi viste det dokumenterte `currentlyInSync`-feltet sammenligning mot oppstrøms repoets egen README i stedet for arbeidsområdet, og rapporterte readmeMatches:false rett etter en vellykket regenerering. Frontmatter har name+description, ingen skript eller medfølgende filer er referert, og jeg fant ingen sikkerhetsfeil (ingen curl|sh, base64, legitimasjonsaksess eller injeksjonstekst) i den 52-linjers SKILL.md.

Testet på: 2026-07-21 · Claude Code 2.x (agent harness)

Installer

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.

Kommandoer og eksempelprompter

/build-workspace-docsRegenererer README.md og WORK_AREAS.md i et ai-agent-skills bibliotek-arbeidsområde via CLI

Skills utløses av vanlige forespørsler — ingen kommandoer å huske. Etter installasjonen aktiverer prompter som disse skillen (på engelsk):

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

Full rapport →