# `VulnCheck.Scanner`
[🔗](https://github.com/Voskan/vulncheck/blob/v1.0.1/lib/vulncheck/scanner.ex#L1)

End-to-end scan pipeline:

  1. load the workspace (lockfiles, scopes, build directories),
  2. load and enrich matching advisories (OSV, EEF CNA, Hex.pm),
  3. summarize compiled `.beam` files and build the call graph,
  4. synthesize OTP/framework entrypoints and edges,
  5. classify every advisory,
  6. apply suppressions (`.vulncheck.ignore`), `--baseline` and `--diff`,
     then any extra post-processing steps.

Steps 3 and 4 are skipped when no advisory needs code analysis.

# `run`

```elixir
@spec run(VulnCheck.Config.t(), keyword()) ::
  {:ok, VulnCheck.Types.ScanReport.t()} | {:error, term()}
```

Runs a scan.

Options are passed to the feed loader (`:http_client`, `:osv_url`,
`:cna_base_url`, `:mitre_base_url`, `:hex_api_url`, ...). In addition:

  * `:beam_cache` — `false` disables the `.beam` summary cache
  * `:ignore` — `false` skips the ignore file
  * `:today` — date used to evaluate suppression expiry
  * `:postprocess` — list of `fun(findings, report_context) -> {findings, violations, warnings}`

---

*Consult [api-reference.md](api-reference.md) for complete listing*
