Build Workspace Docs

SkillAI & models

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

Available today. Use it from your connected AI after setup.

No other account needed.

Connect ahel once, and every AI you use reads what you have installed.

Then ask your AI: use the Build Workspace Docs skill

What this skill tells your AI

The instructions your AI receives, as published by moizibnyousaf/ai-agent-skills in skills/build-workspace-docs/SKILL.md and read by ahel’s review.

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 .ai-agent-skills/config.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.

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

npx ai-agent-skills build-docs

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.

After add, catalog, vendor, or curate commands that change the skills catalog.
After bulk imports from a remote library.
Before committing workspace changes to git.

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.

Advanced