skilld
All skills
shipshitdev avatar

/readme-sync

@768efb9
by Ship Shitshipshitdev/library37 stars
3

Regenerate catalog counts, layout claims, and README summaries from canonical sources. Run after adding, removing, or renaming skills, commands, or bundles.

Ask your Agent

Use this Skill: https://skilld.dev/gh/shipshitdev/library/readme-sync

This session only. Nothing lands on disk.

SKILL.md

≈42 tokens always: the name and description. ≈355 when used: this file.

README and Catalog Sync

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.

Source: SKILL.md on GitHub

Third-party checks

No alerts2mo3 checks · Risk SAFE
  • Gen Agent Trust Hub2mo

    This skill automates the regeneration of a README table by scanning the local filesystem. It is generally safe but includes content from other files in the project without extensive sanitization, which represents a potential surface for indirect prompt injection. It also utilizes a standard third-party linting tool via npm.

  • Socket2mo

    No alerts

  • Snyk2mo

    Risk: LOW · No issues

Provenance

Signed by skilld at 768efb9. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 2 days ago.

Activeupdated 3 months ago

Capability

Other metadata
metadata
{
  "internal": true,
  "version": "1.1.0",
  "tags": "readme, sync, maintenance, automation"
}

README badge

README badge for shipshitdev/library/readme-sync