英文 | Türkçe
输入GitHub仓库URL或本地路径,获取架构、运行指南、风险和可操作的问题。

RepoSherlock不仅仅猜测命令。通过--try-run,它会在沙箱中尝试安装/测试/构建/启动步骤,并在运行报告中记录证据(信号、超时和备注)。
RepoSherlock分析一个公开的GitHub仓库或本地项目路径,并将报告包写入以下目录:
.reposherlock/output/<run-dir>/默认运行目录基于时间戳(例如:20260208-103104)。
输出产物包括:
report.md / report.jsonarchitecture.mmd / architecture.jsonrisks.md / risks.jsonissues.jsonissues.good-first.md / issues.good-first.jsonREADME_2.0.mdrun_attempt.md / run_attempt.json(仅与--try-run一起使用)pr_draft.md(仅与--pr-draft或向导完整Sherlock配置一起使用)启用LLM润色时,会生成额外的变体:
README_2.0.deterministic.md / README_2.0.llm.mdissues.deterministic.json / issues.llm.jsonreport.deterministic.md / report.llm.md运行计划
目标:https://github.com/octocat/Hello-World
尝试运行:已启用
Sherlock思考中
✓ 验证仓库目标和运行时配置
✓ 规划扫描策略和安全执行路径
✓ 准备架构、风险和问题综合
摘要
仓库类型:web
风险:高=0, 中=1, 低=0
输出:.reposherlock/output/20260208-103104
Bun(推荐):
bun install
bun run build
Node回退:
npm install
npm run build
最小输入(交互式向导):
bun run sherlock
分析一个仓库:
bun run sherlock -- analyze https://github.com/octocat/Hello-World --try-run
分析本地路径:
bun run sherlock -- analyze . --no-network --try-run
打开已有运行的摘要:
bun run sherlock -- report .reposherlock/output/<run-dir>
检查本地工具链:
bun run sherlock -- doctor
UI演示模式:
bun run sherlock -- ui-demo
Node回退(如果您不使用Bun):
npm run sherlock
当前版本中,RepoSherlock CLI工作流默认启用LLM润色。确定性分析仍会生成并保存,与LLM润色输出并存。
对于需要凭据的提供商(OpenAI、Gemini、Anthropic、Grok、OpenAI兼容),设置:
export LLM_API_KEY="..."
可选:
LLM_MODELLLM_BASE_URL您也可以在交互式向导中设置提供商/模型/密钥,并将密钥存储在:
~/.reposherlock/credentials.json(权限600)RepoSherlock扫描仓库结构和关键文件,构建本地模块图,提取运行时/环境/风险信号,可选执行沙箱尝试运行,然后写入报告包。启用LLM润色时,它会重写确定性输出以提高清晰度,同时不改变发现的命令和事实。
sherlock。--try-run),并带有超时/输出上限。bun test
# 或
npm test
MIT