Skip to content

cUDGk/readme-claim-check

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 

Repository files navigation

readme-claim-check

README claim vs Repo reality の差分を検査する skill

Markdown License: MIT

README に書いた機能が実装と一致しているかを、エージェントが自動で照合する。


概要

GitHub リポジトリの README に書かれた機能・コマンド・状態表記が、実装・テスト・CLI・ファイル構成と一致しているかを機械的に検査し、差分を Markdown レポートで返す skill。

README を書くツールは多いが、書いた README が正しいかを検査するツールは少ない。

~/.claude/skills/rrc/ に配置して /rrc で起動する skill 形式。

特徴

機能 説明
README claim 抽出 Feature リスト / Status marker / Code block / Badge / Section promise を構造化
マニフェスト解析 package.json / pyproject.toml / Cargo.toml / go.mod / build.gradle / Makefile を読む
CLI 実在性照合 README のコマンド名と manifest の bin / entry point を突合
テスト・CI 検証 tests/ ディレクトリ + workflow YAML + バッジ参照先を確認
安全なコマンド実行 --probe で manifest 登録済みエントリの --help のみ実行(拒否ワードはスキップ)
差分レポート match / mismatch / partial / outdated / undocumented / unknown に分類

処理フロー

flowchart LR
    A[入力<br/>URL or path] --> B[Step 1<br/>準備]
    B --> C[Step 2<br/>README 解析]
    B --> D[Step 3<br/>実装プローブ]
    C --> E[Step 4<br/>照合]
    D --> E
    E --> F[Step 5<br/>レポート]
Loading

インストール

~/.claude/skills/ を読み込む対応エージェントで利用可能。

git clone https://github.com/cUDGk/readme-claim-check.git ~/.claude/skills/rrc

これだけで /rrc が起動可能になる。

使い方

/rrc                              # カレントを検査
/rrc .
/rrc ./path/to/repo
/rrc https://github.com/foo/bar
/rrc . --probe                    # CLI の --help を実行して実在確認
/rrc . --save                     # repo 直下にレポート保存
/rrc . --strict                   # mismatch を強調

自然言語にも対応:

  • 「この repo の README 盛ってない?」
  • 「README と実装合ってる?」
  • 「差分チェックして」

出力

Markdown レポート(要約のみ抜粋):

# Repo Reality Report: <repo-name>

## Summary
- Claims found: 12
- Matches: 7 (58%)
- Mismatches: 3

## Mismatches
### ❌ "Auto-complete CLI" (README L42)
> "Supports tab completion out of the box"
- Reality: completion ファイル無し
- Confidence: high

詳細フォーマットと判定ロジックは SKILL.mdSPEC.md を参照。

安全規則

  • repo への書き込みは --save 時のみ(.repo-reality-report.md
  • README の curl | sh / wget | sh パターンは絶対実行しない
  • --probe でも許可リスト引数 (--help / --version / -h / -V 等) のみ
  • 拒否ワード (rm, curl, sudo, chmod, dd, |, >, &&, ; 等) を含むコマンドは静かにスキップ

ライセンス

MIT License — Copyright (c) 2026 cUDGk

About

README と実装の差分を検査する skill — claim 抽出・マニフェスト解析・CLI 実在性・テスト/CI 検証を機械的に照合

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors