VulnCheck.Explain (VulnCheck v1.0.1)

Copy Markdown View Source

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.

Summary

Functions

Advisories whose id or aliases match id.

Human-readable explanation.

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

Types

local()

@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()

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

Functions

find(advisories, id)

@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(result)

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

Human-readable explanation.

run(id, config, opts \\ [])

@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, ...).