RepoProof 是做什么的?
以全新用户的视角验证仓库。将 README 视为一份契约,而非建议。
默认工作流
- 运行
node scripts/repoproof.mjs audit . --output repoproof-output。 - 在得出结论前先读取
repoproof-output/repoproof-report.json。 - 如果用户明确允许执行,则运行
node scripts/repoproof.mjs prove . --allow-exec --output repoproof-output。 - 如果需要修复,运行
node scripts/repoproof.mjs fix . --dry-run --output repoproof-output并检查repoproof-fixes.patch。 - 只报告证据支持的内容。将未经验证的主张标记为“未经验证”。
安全规则
- 审计模式为默认模式,不得执行仓库代码。
- 证明模式需要用户明确批准(使用
--allow-exec标志或 CI 运行环境)。 - 绝不发布、部署、推送、合并或读取用户机密。
- 在没有真实容器、虚拟机或操作系统沙箱的情况下,绝不声称具有强沙箱能力。
- 使用确定性脚本进行证据收集和脱敏处理。
参考资料
- 阅读
references/workflow.md以了解完整的审计/证明/修复工作流。 - 在执行仓库代码前阅读
references/safety-model.md。 - 当 README 步骤提取存在歧义时阅读
references/extraction-rules.md。 - 在提出编辑建议前阅读
references/fix-policy.md。 - 在解释报告时阅读
references/evidence-schema.md。 - 在添加 CI 前阅读
references/github-action.md。 - 阅读
references/platform-notes.md以了解 Windows、macOS 和 Linux 的差异。