用途:对 GitHub 仓库做开发者体验审计,输出可分享的吐槽报告、按影响力排序的改进计划、理想 README 模板和原始评分。面向开源维护者与开发工具创始人,用于 Show HN、Product Hunt 等发布前的“前五分钟”体验检查。
主要能力:按固定 10 个维度(time_to_first_success、what_is_this_clarity、visual_proof、install_simplicity、runnable_quick_start、documentation_depth、examples、community_signals、trust_signals、marketing_signals)各打 0–10 分,缺失数据记 0 分而非 N/A;总分 0–100 并给出 A/B/C/D/F 等级。吐槽需引用具体发现、文件路径与行号,不点名维护者。改进计划按 impact × (1/effort) 排序,取前 5–10 项。理想 README 用占位符表示缺失链接,长度不超过 100 行。
使用方式:输入本地路径(默认 .)或 https://github.com/owner/repo URL,可选 tone(brutal/honest/kind,默认 honest)、output_dir(默认 dx-roast/)、compare_to(基准仓库)。URL 会先 git clone 到临时目录扫描,本地路径原地只读扫描。运行前需读取 references/scoring-rubric.md、references/roast-voice-guide.md、references/readme-template.md。若为 URL 还会用 gh api 获取 stars、forks、pushed_at 等元数据。
限制:只读扫描,不修改目标仓库;不做安全审计或依赖扫描;不生成营销文案、图片或素材;不发布社交媒体。仓库不可访问时直接退出且不写文件;README 缺失仍继续但相关维度接近 0 分;私有仓库无认证时提示设置 GITHUB_TOKEN 或传本地路径;基准仓库获取失败则跳过对比。GitHub API 出错会在 trust_signals.evidence 记录“github metadata unavailable”。