Hawk-i Docs
Documentation/GETTING STARTED

Installation

Prerequisites

  • Python 3.9+ (developed on 3.12)
  • Docker (optional, required only for the exploit sandbox and the Deep agent)
  • Foundry or Hardhat (optional, for proof-of-concept execution)

via pip (recommended)

$ pip install hawki

Package available at pypi.org/project/hawki

Optional extras

HTML and PDF reports pull in a few extra dependencies. Install them with extras:

$ pip install "hawki[reports]"   # jinja2 + matplotlib for HTML reports
$ pip install "hawki[pdf]"       # adds pdfkit for PDF output
$ pip install "hawki[all]"       # everything

from source

$ git clone https://github.com/gethawki/hawki.git
$ cd hawki
$ pip install -e .

Docker image

$ docker pull levichinecherem/hawki:latest
$ docker run --rm -v $(pwd):/repo levichinecherem/hawki scan /repo

Docker Hub: hub.docker.com/r/levichinecherem/hawki

Verify your setup

Run the preflight health check to confirm Docker, LLM keys, and toolchains are wired up:

$ hawki doctor
PreviousIntroductionNextQuickstart