← ClaudeAtlas

doctruth-clilisted

Compares the CLI flags, subcommands and environment variables a README or docs folder mentions with what the code actually defines (argparse, click, typer, Go flag and cobra, Node commander, and os.environ, process.env, os.Getenv reads). Reports flags that are documented but gone, options that exist but are undocumented, probable renames, defaults that disagree and flags shown under the wrong command, then writes a corrected options table from the code. Use when the user says "is my README still right about the CLI", "the docs mention a flag that does not exist", "which options are undocumented", "generate the options table from the code", "sync the environment variable docs", or "did we rename a flag".
vivekbhange-hub/docs-truth-skill · ★ 0 · Data & Documents · score 75
Install: claude install-skill vivekbhange-hub/docs-truth-skill
# doctruth-cli: the options the docs promise versus the options the code has A user types what the README says. If `--workers` became `--jobs` two releases ago, the README is wrong and the first run fails. `cli_drift.py` reads the docs and the code statically, nothing is imported or executed, and lists every difference. The code wins unless the user says otherwise. ## Inputs - A project folder with docs (README, `docs/`, `skills/`, `agents/`) and the CLI's source. - Optional: `--cli NAME` when the program name is not in `pyproject.toml`, `package.json`, `go.mod` or an argparse `prog=`; `--docs PATH` and `--code PATH` to narrow either side. - Commands below say `python3`; on Windows use `python` (or `py -3`). ## Outputs - The findings table (CD001 to CD010) with severity, `file:line` and section. - A corrected options table generated from the code, ready to paste. - Doc patches that apply it, plus a list of things only the user can decide (was the code wrong?). ## Steps 1. **Confirm permission.** Read and edit docs only in a repository the user owns or is authorized to change. Never run the CLI under analysis to "see what it prints"; the script reads source. 2. **Run the comparison.** ``` python3 "${CLAUDE_SKILL_DIR}/cli_drift.py" . --json > doctruth-cli.json python3 "${CLAUDE_SKILL_DIR}/cli_drift.py" . ``` For CI use `--fail-on high`. `--include-system` also reports PATH, HOME, CI and GITHUB_*. 3. **Check the coverage note first.** If the report s