sync-docs

A command for keeping a project's documentation, agent instructions, and README aligned after changes.

In plain words
What is it for?
Use it after changing recipes, properties, request data, component APIs, capture types, or server helpers so all three documentation sources match.
Why use it?
It prevents users and developers from finding different instructions in the docs site, skill file, and README.

Command for Claude Code

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 commands/fvckprth/remediate/sync-docs
Clone the repo
git clone --depth 1 https://github.com/fvckprth/remediate

Made for: Claude Code.

Per session 14 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 443 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.00014 $0.00443
Opus 5 $0.00007 $0.00221
Sonnet 5 $0.00003 $0.00089
Haiku 4.5 $0.00001 $0.00044

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

Security

Grade A, and why

sync-docs 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 2d 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/commands/sync-docs.md · 49 lines

What it actually says

Sync Docs

keep the docs site, agent skill, and package README in sync after changes.

when to run

after any change to: recipes, props, payload shape, component API, capture types, or server helpers.

sources of truth

  • docs site (/Users/parthpatel/Desktop/Projects/remediate-mktg/src/app/docs/) — the canonical reference
  • agent skill (skills/remediate/SKILL.md) — must match the docs recipes and component patterns
  • package README (README.md at repo root) — quick-start subset of the docs

steps

  1. identify what changed

    • if $ARGUMENTS is provided, use it as the description of what changed
    • if empty, diff the docs site against the skill and README to find mismatches
  2. read current state of all three

    • read the relevant docs pages (install, recipes, payload, reference)
    • read skills/remediate/SKILL.md
    • read README.md
  3. update the skill

    • sync recipe templates to match docs (same code, same type narrowing, same file handling)
    • sync backend detection signals if new backends were added
    • sync component mounting instructions if props changed
    • sync notes section if capture types or API changed
  4. update the README

    • sync the server route example to match the install page
    • sync the props table to match the reference page
    • sync capture type descriptions if they changed
    • keep the README minimal — it's a quick-start, not the full docs
  5. commit and push both repos

    • skill + README changes in the package repo: docs: sync skill and readme with docs site
    • if docs site needed fixes too, commit those separately in remediate-mktg
  6. confirm

    • list what was updated in each file
    • flag anything that looked inconsistent but wasn't clear how to resolve
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. 2d ago First seen · 49 lines · 14 tokens per session scan A 2ea73886c5f9

Subscribe to this mod's changes

sync-docs is a command published in the GitHub repository fvckprth/remediate (11 stars, last pushed 3mo ago), licensed MIT. It adds 14 tokens to every session and 443 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-30.