About

Imported from shipshitdev/skills (.agents/skills/readme-sync/SKILL.md). Install upstream with npx skills add shipshitdev/skills --skill readme-sync. Copyright stays with the author.

README and Catalog Sync

Name: readme-sync
Author: shipshitdev

Regenerate catalog.json and every marked count/layout summary from the actual skill, command, bundle, and tracked-path sources.

When to Run

After adding new skills
After removing or renaming skills
After adding or removing commands or bundles
After importing skills from external repos
When any catalog count or directory claim does not match the repository

Process

1. Generate the Catalog and Documentation Blocks

bun run catalog:generate

The generator derives:

skills from skills/*/SKILL.md;
commands from commands/*.md;
bundles from scripts/plugin-categories.json;
plugins as skills plus bundles;
top-level layout from git ls-files.

It writes the single generated source catalog.json, then updates marked blocks in README.md, AGENTS.md, and memory/architecture docs plus the package description. Do not edit text between catalog-*:start and catalog-*:end markers manually.

2. Validate Without Writing

bun run catalog:check

The lightweight repository validator also runs this check, and CI regenerates the catalog and fails if any generated file changes.

Safety

Preserve prose outside generated markers.
Never infer counts from README text.
Never add a top-level path to the generated layout unless it is tracked.
Review catalog.json and generated documentation diffs before committing.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/shipshitdev-skills-readme-sync/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

shipshitdev-skills-readme-sync.ocm.jsonjson

{
  "ocm": "1",
  "id": "shipshitdev-skills-readme-sync",
  "kind": "skill",
  "name": "readme-sync",
  "description": "Regenerate catalog counts, layout claims, and README summaries from canonical sources. Run after adding, removing, or renaming skills, commands, or bundles.",
  "publisher": "shipshitdev",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "general"
    ],
    "tags": [
      "skill-md",
      "readme",
      "sync",
      "maintenance",
      "automation",
      "skills-sh"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Regenerate catalog counts, layout claims, and README summaries from canonical sources. Run after adding, removing, or renaming skills, commands, or bundles."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "skills.sh",
      "repository": "https://github.com/shipshitdev/skills",
      "path": ".agents/skills/readme-sync/SKILL.md",
      "ref": "HEAD",
      "url": "https://github.com/shipshitdev/skills/blob/HEAD/.agents/skills/readme-sync/SKILL.md",
      "key": "shipshitdev/skills/.agents/skills/readme-sync/SKILL.md"
    }
  },
  "instructions": "# README and Catalog Sync\n\nRegenerate `catalog.json` and every marked count/layout summary from the actual\nskill, command, bundle, and tracked-path sources.\n\n## When to Run\n\n- After adding new skills\n- After removing or renaming skills\n- After adding or removing commands or bundles\n- After importing skills from external repos\n- When any catalog count or directory claim does not match the repository\n\n## Process\n\n### 1. Generate the Catalog and Documentation Blocks\n\n```bash\nbun run catalog:generate\n```\n\nThe generator derives:\n\n- skills from `skills/*/SKILL.md`;\n- commands from `commands/*.md`;\n-",
  "cost": {
    "context_tokens": 354
  }
}

Fetch it by URL: GET /api/v1/registry/shipshitdev-skills-readme-sync/manifest?version=1.0.0

Reviews

Star ratings from people who tried it. One review per account; edit yours any time.

No reviews yet. Install it, try it, and be the first to rate it.