{
 "schema_version": 1,
 "generated": "2026-10-30",
 "id": "winnin-farol--score-the-merge-risk-of-a-branch-with-farol",
 "repo": "winnin/farol",
 "repo_url": "https://github.com/winnin/farol",
 "repo_slug": "winnin-farol",
 "title": "Score the merge risk of a branch and see which files carry it",
 "page_title": "How to score the merge risk of a branch and see which files carry it with Farol",
 "summary": "Run Farol locally on a feature branch to get a verdict, a risk score and the files to read first.",
 "who": "A reviewer facing a 40-file agent-written PR who needs to know where to look.",
 "problem": "Review attention spread evenly over every PR turns into skimming, and a small change with large reach slips through.",
 "outcome": "An HTML report with a verdict, a 0 to 100 score, the pages and endpoints reached and what to test by hand.",
 "steps": [
  "Add a Farol.config.json at the project root describing your stack (one line is enough to start)",
  "Run `npx @winninjs/farol routes` to check which pages, endpoints and jobs it found",
  "Check out the branch and run `npx @winninjs/farol analyze --base origin/main --head HEAD --out farol.json`",
  "Run `npx @winninjs/farol html --in farol.json --out farol.html` and open the report",
  "Read the must-check items first, then the files by risk"
 ],
 "agent_prompt": "Run winnin/farol on my branch <branch> against origin/main: set up farol.config.json for <stack>, analyze, generate the HTML report, and summarize the verdict, the score and the top 3 risky files.",
 "agents": [
  "claude-code",
  "codex",
  "cursor"
 ],
 "difficulty": "Beginner",
 "time": "15 minutes",
 "basis": "readme",
 "caveat": "",
 "category": "Software and DevOps",
 "tags": [
  "Software and DevOps"
 ],
 "lang": "typescript",
 "requirements": [
  "Node.js 22+ and git",
  "go for Go projects, python3 3.11+ for Python projects",
  "Optional: coverage, lint and audit reports from your CI"
 ],
 "risk": "none",
 "seen_in_the_wild": false,
 "mentioned_publicly": false,
 "risks": [],
 "best": true,
 "score": 1.0,
 "evidence": [],
 "url": "https://dedupedai.com/use-cases/winnin-farol/score-the-merge-risk-of-a-branch-with-farol/",
 "md": "https://dedupedai.com/use-cases/winnin-farol/score-the-merge-risk-of-a-branch-with-farol/index.md",
 "disclaimer": "Deduped lists open-source repositories that belong to other people. We do not own, maintain, audit, or vouch for any of them, and a repo appearing here is not an endorsement or a safety check. The use cases, steps, and prompts are written by AI and may be incomplete, outdated, or just wrong. Where a use case is marked \"Seen in the wild\", we link to public posts where someone described something similar, but we have not verified those posts and the use case itself is still our AI's own write-up. Use all of this at your own risk. Only run code, commands, or agents on systems and accounts you are authorized to use, and read the code and every command before you run it, especially anything that touches credentials, files, or the network. Nothing here is professional, security, legal, or financial advice. All trademarks and project names belong to their respective owners, and their use here does not imply affiliation. Content is provided as is, without warranties of any kind. Found a mistake, a safety problem, or something you want removed? Email hello@dedupedai.com and we will look at it promptly.",
 "api": "https://dedupedai.com/api/v1/usecases/winnin-farol--score-the-merge-risk-of-a-branch-with-farol.json",
 "api_version": "v1"
}