docs-sync

docs-sync is a skill for Claude Code, Codex from shutootaki/gwm. It costs 154 tokens per session (2,105 once invoked), scanned A, original, MIT.

A documentation consistency checker for a Rust command-line application. It compares the source files that define commands and settings with the help text and README files, including the Japanese README.

In plain words
What is it for?
Checking CLI commands and options, configuration fields, help screens, and README command references for drift from their source definitions.
Why use it?
It finds documentation that no longer matches the code after commands, options, or configuration fields change. This helps prevent missing, outdated, or deprecated usage information.

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/shutootaki/gwm/docs-sync
Any agent
npx skills add shutootaki/gwm --skill docs-sync
Clone the repo
git clone --depth 1 https://github.com/shutootaki/gwm

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 docs-sync

README.md
[![agentmods](https://agentmods.dev/badge/skills/shutootaki/gwm/docs-sync.svg)](https://agentmods.dev/skills/shutootaki/gwm/docs-sync)
Your own site
<a href="https://agentmods.dev/skills/shutootaki/gwm/docs-sync"><img src="https://agentmods.dev/badge/skills/shutootaki/gwm/docs-sync.svg" alt="Measured on agentmods" height="20"></a>
Per session 154 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,105 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.00154 $0.02105
Opus 5 $0.00077 $0.01052
Sonnet 5 $0.00031 $0.00421
Haiku 4.5 $0.00015 $0.00211

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

Security

Grade A, and why

docs-sync 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.

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/extract-metadata.sh), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

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/docs-sync/SKILL.md · 168 lines

How it starts

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

docs-sync: ドキュメント整合性チェック

ソースコード(SOURCE OF TRUTH)とドキュメント間のドリフトを検出し修正提案する。

ソースファイルマップ

ファイル 役割
src/cli/args.rs CLI定義(SOURCE OF TRUTH)
src/config/types.rs 設定型定義(SOURCE OF TRUTH)
src/ui/views/help.rs TUIヘルプテキスト(同期先)
README.md 英語ドキュメント(同期先)
README_JA.md 日本語ドキュメント(同期先)

チェック手順

5つのファイルを読み取り、以下6チェックを順に実施する。 オプションで scripts/extract-metadata.sh を先に実行し、機械的抽出結果を補助に使える。

Check 1: CLI Args → Help Text

args.rsの非hiddenコマンド/オプションがhelp.rsに正確に反映されているか確認する。

  1. args.rsから抽出:

    • Commands enumの非hiddenバリアント(hide = trueを除く)
    • 各Args構造体の非hiddenフィールドの short/long/docコメント
    • コマンドエイリアス(alias = "..."
  2. help.rsの各定数(GLOBAL, LIST, ADD, REMOVE, GO, CLEAN, SYNC, HELP)と比較:

    • 非hiddenオプションの欠落
    • hiddenなのにhelp.rsに残っているオプション
    • short/long形式の不一致

Check 2: CLI Args → README

READMEのCommand Referenceセクションがargs.rsと一致しているか確認する。

  1. Check 1で抽出した非hiddenコマンド/オプション一覧を使用
  2. README.md## Commandsや各コマンドセクションと比較:
    • コマンド一覧テーブルの網羅性
    • 各コマンドのオプション記載の正確性
    • deprecated構文が例に含まれていないか

Check 3: Config Types → README

types.rsの全設定フィールドがREADMEに正しく記載されているか確認する。

  1. types.rsから抽出:

    • Config構造体と全ネスト構造体のフィールド名
    • デフォルト値(default_*関数とvirtual_env_defaults定数)
    • deprecatedフィールド(docコメントで明示)
  2. README.mdのConfiguration Optionsテーブルと比較:

    • フィールドの欠落(特にvirtual_env_handlingセクション)
    • デフォルト値の不一致
    • 設定例の構造が現在のスキーマと矛盾しないか

既知の注意点:

  • CopyIgnoredFilesConfigのデフォルトはdefault_copy_enabled()=true, default_copy_patterns()=[".env", ".env.*", ".env.local", ".env.*.local"]
  • default_exclude_patterns()=[".env.example", ".env.sample"]
  • VirtualEnvConfigのデフォルトはvirtual_env_defaultsモジュール定数を参照

Check 4: README ↔ README_JA 構造整合

英語版と日本語版で同じコマンド・オプション・設定が記載されているか確認する。

README.mdREADME_JA.mdの以下を構造的に比較(翻訳内容の正確性は対象外):

  • Commandsテーブルの行数とコマンド名
  • 各コマンドのオプションテーブルの行数とオプション名
  • Configuration Optionsテーブルの行数と項目名
  • セクション構成(h2, h3レベル)

Check 5: 環境変数の網羅性

コード内のGWM_プレフィックス環境変数がREADMEに記載されているか確認する。

Read the full file on GitHub · 168 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 · 168 lines · 154 tokens per session scan A 0648c9cb016d

Subscribe to this mod's changes

docs-sync is a skill published in the GitHub repository shutootaki/gwm (18 stars, last pushed 7mo ago), licensed MIT. It adds 154 tokens to every session and 2,105 once invoked, about $0.0008 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.

Related

Other skills, from other repositories

spec-kitty-charter-doctrine

Run charter interview, generation, context, and sync workflows for project governance in Spec Kitty 3.x. Access doctrine artifacts programmatically via DoctrineService. Resolve agent profiles. Load action-scoped governance context iteratively, not all at once. Triggers: "interview for charter", "generate charter"…

Priivacy-ai/spec-kitty · 135 tokens

neo4j-modeling-skill

Design, review, and refactor Neo4j graph data models. Use when choosing node labels vs relationship types vs properties, migrating relational/document schemas to graph, detecting anti-patterns (generic labels, supernodes, missing constraints), designing intermediate nodes for n-ary relationships, enforcing schema with…

neo4j-contrib/neo4j-skills · 152 tokens

alphafold-database

Access AlphaFold 200M+ AI-predicted protein structures. Retrieve structures by UniProt ID, download PDB/mmCIF files, analyze confidence metrics (pLDDT, PAE), for drug discovery and structural biology.

agent-skills-hub/agent-skills-hub · 54 tokens

lov-deploy-to-vercel

Deploy frontend projects to Vercel with automatic custom domain setup. Handles Vite, Next.js, CRA, and static sites. Auto-configures Cloudflare DNS CNAME records and Vercel domain aliases. Supports SPA routing via vercel.json. Trigger when user says "deploy to vercel", "部署到 vercel", "vercel deploy", or mentions a…

lovstudio/skills · 92 tokens

lov-bp-outline

Turn existing project materials into a source-backed investor BP brief, evidence ledger, and 12–15 slide outline. Use before making slides, when the product positioning is unclear, or when an existing outline is too technical, generic, or unsupported. Trigger on "写 BP 大纲", "融资叙事", "梳理商业计划书", "先不要做 PPT", "BP outline"…

lovstudio/skills · 97 tokens

github-create-pr

Create GitHub pull requests from a local branch using a reviewable workflow for branch checks, diff analysis, PR title/body writing, and gh CLI creation. Use when opening a PR, drafting or improving a PR description, preparing a branch for review, or adding reviewers on GitHub.

flc1125/skills · 61 tokens