claude

readme-truth-checker

Detects drift between a Python project's README.md and reality. Runs the README's quickstart steps in a clean Docker container, diagnoses any failures, and (with your permission) opens a PR with the fix.

1 on GitHubv0.1.0MITupdated 5 months ago
/

Plugin readme-truth-checker from marketplace readme-truth-checker-local in rahulchawla18/README-Truth-Checker. Commands read from the repo's manifest — 1 month ago.

What it installs

Skills (3)

  • clean-room-runner

    How to execute README steps inside a Dockerized Python environment. Load this when running extracted commands against a clean container, dealing with long-running servers, or troubleshooting why a runner pass differs from local.

  • drift-diagnoser

    Patterns for mapping README step failures to root causes by inspecting the real Python codebase. Load this when diagnosing why a README step failed (missing env var, wrong version, stale install command, missing migration, wrong port, renamed entry point).

  • readme-parser

    Conventions for extracting and classifying shell commands from README markdown. Load this when parsing fenced code blocks, detecting placeholders, distinguishing setup/install/run/test commands, or deciding which README lines are testable.

Slash commands (1)

  • /readme-truth-checker:readme-check

    Validate the root README.md by running its steps in a clean Docker container. Python projects only. Reports drift, proposes fixes, asks before opening a PR.

Subagents (1)

  • readme-validator

    End-to-end orchestrator for the README Truth Checker pipeline on a Python project. Returns a structured drift report and proposes verified fixes. Does NOT modify files or open PRs without explicit user permission via AskUserQuestion.

View source on GitHub

Maintain readme-truth-checker?

This page updates itself from your repo. Add the badge to your README, or get it Featured to pin it above the organic results with a followed link to your site.

claude & codex pluginslisted