Clarify requirements before implementing. Do not use automatically, only when invoked explicitly.
The English summary is being prepared. Showing the original description.
MoizIbnYousaf/ai-agent-skills1.2KUpdated Sep 22, 2026
FreePublished on GitHub
build-workspace-docs
Use when regenerating README.md and WORK_AREAS.md in a managed library workspace. Always dry-run first to preview changes.
The English summary is being prepared. Showing the original description.
See how to installFiles included (1)
- SKILL.md1.5 KB
SKILL.md (original)
Review the instructions the agent will receive before you install.
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.
Reviews
No reviews yet. Tell others what you thought.
Comments
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
More skills from this repository
Use when checking the overall health of a skills library. Run doctor, validate, check for stale skills, and verify generated docs are in sync.
The English summary is being prepared. Showing the original description.
MoizIbnYousaf/ai-agent-skills1.2KUpdated Sep 22, 2026
Backend API design, database architecture, microservices patterns, and test-driven development. Use for designing APIs, database schemas, or backend system architecture.
The English summary is being prepared. Showing the original description.
MoizIbnYousaf/ai-agent-skills1.2KUpdated Sep 22, 2026
best-practices
FreeTransforms vague prompts into optimized Claude Code prompts. Adds verification, specific context, constraints, and proper phasing. Invoke with /best-practices.
The English summary is being prepared. Showing the original description.
MoizIbnYousaf/ai-agent-skills1.2KUpdated Sep 22, 2026
Use when exploring the ai-agent-skills catalog to find, compare, and evaluate skills before installing. Always use --fields to limit output size and --dry-run before committing to an install.
The English summary is being prepared. Showing the original description.
MoizIbnYousaf/ai-agent-skills1.2KUpdated Sep 22, 2026
Automatically creates user-facing changelogs from git commits by analyzing commit history, categorizing changes, and transforming technical commits into clear, customer-friendly release notes. Turns hours of manual changelog writing into minutes of automated generation.
The English summary is being prepared. Showing the original description.
MoizIbnYousaf/ai-agent-skills1.2KUpdated Sep 22, 2026