sync-readme

sync-readme is a skill for Claude Code, Codex from yu-iskw/coding-agent-fabric. It costs 21 tokens per session (552 once invoked), scanned A, original, Apache-2.0.

A documentation workflow that keeps technical parts of README.md and CONTRIBUTING.md aligned with the codebase. It covers the layout, commands, scripts, and architecture of a monorepo, which is one repository containing multiple related packages.

In plain words
What is it for?
Inspecting the repository and updating marked sections that describe packages, scripts, CLI commands, and architecture.
Why use it?
It helps prevent documentation from becoming outdated after packages, scripts, commands, or package relationships change.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/yu-iskw/coding-agent-fabric/sync-readme
Any agent
npx skills add yu-iskw/coding-agent-fabric --skill sync-readme
Clone the repo
git clone --depth 1 https://github.com/yu-iskw/coding-agent-fabric

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for sync-readme

README.md
[![agentmods](https://agentmods.dev/badge/skills/yu-iskw/coding-agent-fabric/sync-readme.svg)](https://agentmods.dev/skills/yu-iskw/coding-agent-fabric/sync-readme)
Your own site
<a href="https://agentmods.dev/skills/yu-iskw/coding-agent-fabric/sync-readme"><img src="https://agentmods.dev/badge/skills/yu-iskw/coding-agent-fabric/sync-readme.svg" alt="Measured on agentmods" height="20"></a>
Per session 21 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 552 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00021 $0.00552
Opus 5 $0.00010 $0.00276
Sonnet 5 $0.00004 $0.00110
Haiku 4.5 $0.00002 $0.00055

Measured 4d ago against content hash 960095d7c250, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

sync-readme scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 4d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude/skills/sync-readme/SKILL.md · 46 lines

How it starts

The opening of the file, as written. The whole thing — 46 lines — stays where its author put it; the contents beside it link to each section on GitHub.

sync-readme

Use this skill to keep the technical documentation (README.md and CONTRIBUTING.md) up-to-date with the codebase.

When to Use

  • After adding or renaming packages in the monorepo.
  • After adding or modifying root scripts in package.json.
  • After adding or changing CLI commands or subcommands.
  • After significant architectural changes or package relationship updates.

Workflow

  1. Analyze Project State: Directly observe the project to gather the necessary information:

    • Layout: List directories in packages/ and packages/plugins/ to see the monorepo structure.
    • Scripts: Read the root package.json to see available scripts.
    • Commands: Read CLI command definitions in packages/cli/src/commands/ to identify commands and subcommands.
  2. Locate Sync Markers: Find the following markers in the documentation files:

    • <!-- SYNC:LAYOUT --> ... <!-- /SYNC:LAYOUT -->
    • <!-- SYNC:SCRIPTS --> ... <!-- /SYNC:SCRIPTS -->
    • <!-- SYNC:COMMANDS --> ... <!-- /SYNC:COMMANDS -->
    • <!-- SYNC:ARCHITECTURE --> ... <!-- /SYNC:ARCHITECTURE -->
  3. Update Content: Update the content between the markers based on your observations:

    • Layout -> SYNC:LAYOUT (usually in CONTRIBUTING.md): List packages and their descriptions from their respective package.json files.
    • Scripts -> SYNC:SCRIPTS (usually in CONTRIBUTING.md): Format scripts from the root package.json as a bulleted list.
    • Commands -> SYNC:COMMANDS (usually in README.md): Format CLI commands as markdown headings with bash examples.
    • Architecture -> SYNC:ARCHITECTURE (usually in CONTRIBUTING.md): Review and update the Mermaid diagram if package relationships or key components have changed.
  4. Preserve Formatting: Ensure that you keep the markers themselves and only update the content between them. Use appropriate markdown blocks (code blocks, lists) that match the existing documentation style.

Read the full file on GitHub · 46 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 4d ago First seen · 46 lines · 21 tokens per session scan A 960095d7c250

Subscribe to this mod's changes

sync-readme is a skill published in the GitHub repository yu-iskw/coding-agent-fabric (1 stars, last pushed 20d ago), licensed Apache-2.0. It adds 21 tokens to every session and 552 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.