AugmentClaude

Workspace Docs Builder

Regenerate README and documentation files from your skills catalog.

Installation

  1. Make sure Claude is on your device and in your terminal.

    Skills load from ~/.claude/skills/ when Claude Code starts up — so you need it on your machine first. If you don't have it yet, install it once with the command below, then run claude in any terminal to verify.

    One-time setup
    npm i -g @anthropic-ai/claude-code

    Already have it? Skip ahead.

  2. Paste into Claude Code or into your terminal.

    This copies the whole skill folder into ~/.claude/skills/build-workspace-docs-moizibnyousaf/ — the SKILL.md plus any scripts, reference docs, or templates the skill ships with. Safe default: works for every skill.

    Faster alternative (instruction-only skills)

    Skips the clone and grabs only the SKILL.md file. Don't use this if the skill ships Python scripts, reference markdowns, or asset templates — they won't be downloaded and the skill will fail when it tries to load them.

    Quick install (SKILL.md only)
    Sign up to copy
  3. Restart Claude Code.

    Quit and reopen Claude Code (or any other agent that loads from ~/.claude/skills/). New skills are picked up on startup.

  4. Just ask Claude.

    Skills auto-activate when your request matches the skill's description — no slash command needed. Trigger phrases live in the skill's own frontmatter; you can read them in the “What this skill does” section above.

Prefer to read the source first? Open on GitHub.

When Claude uses it

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

What this skill does

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

  1. Preview what would change.
npx ai-agent-skills build-docs --dry-run
  1. Regenerate the docs.
npx ai-agent-skills build-docs
  1. 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.

Gotchas

  • Running outside a workspace will fail with a clear error. Use init-library to 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