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

Looks up one advisory and, when the target directory is a project that
locks the affected package, its local reachability status.

Identifiers are matched case-insensitively against advisory ids and
aliases; `CVE-2026-1234` also matches `EEF-CVE-2026-1234`.

# `local`

```elixir
@type local() ::
  nil
  | %{
      workspace: VulnCheck.Types.Workspace.t(),
      findings: [VulnCheck.Types.Finding.t()],
      visible_findings: [VulnCheck.Types.Finding.t()],
      outcomes: [map()],
      warnings: [String.t()]
    }
  | %{error: term()}
```

# `result`

```elixir
@type result() :: %{
  query: String.t(),
  advisories: [VulnCheck.Types.Advisory.t()],
  local: local(),
  warnings: [String.t()]
}
```

# `find`

```elixir
@spec find([VulnCheck.Types.Advisory.t()], String.t()) ::
  {:ok, [VulnCheck.Types.Advisory.t()]}
  | {:error, {:advisory_not_found, String.t()}}
```

Advisories whose id or aliases match `id`.

# `format`

```elixir
@spec format(result()) :: String.t()
```

Human-readable explanation.

# `run`

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

Finds the advisory `id`. Options are feed options accepted by
`VulnCheck.Scanner.run/2` (`:osv_url`, `:cna_base_url`, `:http_client`, ...).

---

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