moizibnyousaf/build-workspace-docs
skills/build-workspace-docs/SKILL.md
Use when regenerating README.md and WORK_AREAS.md in a managed library workspace. Always dry-run first to preview changes.
$ install --global
skillsauthnpx skillsauth add moizibnyousaf/ai-agent-skills build-workspace-docsInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: May 4, 2026, 6:39 AM189.7s1 file scanned
SKILL.md
- name:
- build-workspace-docs
- description:
- Use when regenerating README.md and WORK_AREAS.md in a managed library workspace. Always dry-run first to preview changes.
- category:
- workflow
- version:
- 4.1.0
Build Workspace Docs
Goal
Keep workspace documentation in sync with the skills catalog after adding, removing, or curating skills.
Guardrails
- Always use
--dry-runbefore 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 jsonto 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, orcuratecommands that change the skills catalog. - After bulk imports from a remote library.
- Before committing workspace changes to git.
Gotchas
- Running outside a workspace will fail with a clear error. Use
init-libraryto create one first. - The generated docs use HTML comment markers (
<!-- GENERATED:...:start/end -->) as boundaries. Do not remove these markers from the template sections.
Related Skills
moizibnyousaf/update-installed-skills
testing
VerifiedTrustedCommunity
Use when syncing or updating previously installed skills to their latest version. Always dry-run updates before applying, and check for breaking changes.
1,045SKILL.mdUpdated May 4, 2026
moizibnyousaf/share-a-library
development
VerifiedTrustedCommunity
Use when a managed library is ready to publish to GitHub and hand to teammates as an install command. Run the GitHub publishing steps, then return the exact shareable install command.
1,045SKILL.mdUpdated May 4, 2026
moizibnyousaf/review-a-skill
development
VerifiedTrustedCommunity
Use when evaluating whether a skill belongs in a library. Preview content, check frontmatter, validate structure, and decide whether to keep, curate, or remove.
1,045SKILL.mdUpdated May 4, 2026
moizibnyousaf/migrate-skills-between-libraries
development
VerifiedTrustedCommunity
Use when moving skills between library workspaces or upgrading from a personal library to a team library. Export from one workspace, import into another.
1,045SKILL.mdUpdated May 4, 2026