I let an AI agent write a README for a real repo — here's what it produced

说明与用途

该管道通过提取代码中的事实并让LLM生成README，然后验证输出，确保生成的README完全准确且无虚构内容。

问题

Small open‑source projects often have README files that no longer match the code, leading to confusion and misuse. The goal was to generate a README that accurately reflects the repository’s flags, environment variables, and license, without hallucinating unsupported features.

结果

The pipeline produced a fully accurate README for the ped CLI tool, with zero invented flags or env vars. Verification ensured factual correctness, and the only issue was an inherited mistake from the original README, which was manually corrected.

工作流

• 1. Fetch repository files via HTTP.
• 2. Extract deterministic facts from pyproject.toml, argparse calls, os.environ lookups, and LICENSE.
• 3. Feed extracted facts and source files to an LLM to generate a README.
• 4. Verify the README against extracted facts, rejecting any invented flags or env vars.

证据

Zero invented flags, zero invented environment variables. Not because the model is trustworthy — because anything it invented would have been caught and the whole deliverable rejected.

来源

The Bash tab-completion section came out as: python -m ped.install_completion > /usr/local/etc/bash_completion.d

来源