build-workspace-docs

Original：🇺🇸 English

Translated

Use when regenerating README.md and WORK_AREAS.md in a managed library workspace. Always dry-run first to preview changes.

2installs

Added on2026-04-11

NPX Install

npx skill4agent add skillcreatorai/ai-agent-skills build-workspace-docs

Keep workspace documentation in sync with the skills catalog after adding, removing, or curating skills.

Always use
```
--dry-run
```
before regenerating docs to preview what will change.
Only run from inside an initialized library workspace (a directory with
```
.workspace.json
```
).
Never hand-edit the generated sections of README.md or WORK_AREAS.md. The CLI will overwrite them.
Use
```
--format json
```
to capture structured results for automation pipelines.

bash

npx ai-agent-skills build-docs --dry-run

bash

npx ai-agent-skills build-docs

bash

npx ai-agent-skills build-docs --dry-run --format json

The JSON output includes

currentlyInSync

to tell you whether docs were already up to date.

Running outside a workspace will fail with a clear error. Use
```
init-library
```
to create one first.
The generated docs use HTML comment markers (
```

```
) as boundaries. Do not remove these markers from the template sections.