Hawk-i Docs
Documentation/CORE WORKFLOW

Audit-Grade Reporting

Hawk-i produces professional, audit-grade reports suitable for team reviews, auditor handoffs, and bug-bounty submissions. Reports can be generated during a scan or re-rendered later from a saved findings JSON with hawki report.

Report styles

  • audit - a full security-audit layout: executive summary, severity counts, security score, and per-finding detail.
  • immunefi - an Immunefi-style bug-bounty submission format, ready to file against a bounty program.
$ hawki report --input findings.json --style audit --format pdf
$ hawki report --input findings.json --style immunefi --format md

Output formats

Markdown, JSON, HTML, and PDF. HTML and PDF require the reports and pdf extras (PDF is rendered by converting the HTML through pdfkit).

Per-finding detail

  • Title and severity
  • File and line number
  • Vulnerable code snippet
  • Recommended fix snippet, from the remediation templates
  • Explanation and impact (LLM reasoning or the rule's fallback template)

JSON export as a first-class output

Every scan writes structured JSON to ./hawki_reports/. That JSON is the canonical record of a scan: feed it back into hawki report or hawki score, diff it across runs, or wire it into CI. The dedicated hawki export command exists for pushing findings into other structured formats.