SkillsAdd

shipshitdev/skills

readme-sync

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

First seen Apr 22, 2026

Installation

$ npx skills add shipshitdev/skills --skill readme-sync
View on skills.sh ↗ GitHub repository ↗

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

create-readme Similar name
github/awesome-copilot

Create a README.md file for the project

18.1K installs
readme-blueprint-generator Similar name
github/awesome-copilot

Intelligent README.md generation prompt that analyzes project documentation structure and creat…

9.6K installs
indexion-readme Similar name
trkbt10/indexion-skills

README construction — initialize template structure, generate per-package READMEs from doc comm…

5.1K installs
crafting-effective-readmes Similar name
softaworks/agent-toolkit

Use when writing or improving README files. Not all READMEs are the same — provides templates a…

4.1K installs
beautify-github-readme Similar name
oil-oil/beautify-github-readme

Redesign GitHub README homepages or create project-native pure SVG, hybrid SVG-composed PNG/Web…

915 installs
readme Similar name
boshu2/agentops

Draft or improve README docs.

766 installs

Also in this package

Other skills from shipshitdev/skills · top by installs.

npx skills add shipshitdev/skills
financial-operations-expert 1.7K youtube-video-analyst 1.1K nestjs-testing-expert 705 copywriter 438 agent-browser 393 playwright-e2e-init 360 competitive-intelligence-analyst 344 context-optimization 343 design-consistency-auditor 336 brand-name-generator 329

Browse all from shipshitdev/skills

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 35
Default branch master
Open issues 1
Status Active

Skill metadata

Parsed from SKILL.md frontmatter.

Version1.1.0
More metadata
internal
1
version
1.1.0
tags
readme, sync, maintenance, automation

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 1,717 B
  • docs SUMMARY.md 175 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 46 installs

SKILL.md

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.