Build Workspace Docs

Regenerates README.md and WORK_AREAS.md after you've modified your skills catalog. The CLI injects content between HTML comment markers, so you can still hand-write the surrounding template without it getting clobbered. Always dry-run first to see what's about to change. You'll run this after adding, removing, or curating skills, or before committing to git. The JSON output flag is handy for CI pipelines since it includes a currentlyInSync boolean. One thing to remember: it only works inside an initialized library workspace, and if you delete those HTML boundary markers, you'll break the regeneration.

skills.sh installs: 172
GitHub stars: 1.2K
last updated: May 5, 2026

View on GitHub

Install

$ npx -y skills add moizibnyousaf/ai-agent-skills --skill build-workspace-docs --agent claude-code

Installs into .claude/skills of the current project.

Files

Build Workspace Docs

Goal

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

Guardrails

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.

Workflow

Preview what would change.

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

Regenerate the docs.

npx ai-agent-skills build-docs

Verify the output.

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.

When to Run

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.