Quick Start

This guide assumes you've installed the chainvet CLI (chainvet --version works).

Scan a contract

Point chainvet scan at a .sol file or a directory of contracts. With no flags it runs the hybrid engine — the deepest mode — and prints a colored, tabular report.

chainvet scan Vault.sol

A directory works too — Chainvet loads the whole project:

chainvet scan contracts/

Read the results

Each finding carries:

a detector ID (e.g. RE-04, AC-01),
a severity — the potential impact (high / medium / low),
a confidence — the detector's own precision estimate (high / medium / low),
a category and the engine that found it,
a message and a source location.

Triage by severity first, then confidence: a high-severity, high-confidence finding is the one to fix first. Low-confidence findings may include false positives — read the location. See Severity & Confidence.

Pick a faster mode

Hybrid is thorough but spends a fuzzing budget. For a quick, deterministic pass use static analysis:

chainvet scan -m static contracts/

The modes are static, symbolic, fuzzing, and hybrid — see Analysis engines.

Get machine-readable output

For scripting and agent workflows, emit JSON:

chainvet scan -f json Vault.sol

Generate an audit report

Produce a Cyfrin-style audit report in Markdown, HTML, or PDF:

chainvet scan -f md   -o audit.md   contracts/
chainvet scan -f html -o audit.html contracts/
chainvet scan -f pdf  -o audit.pdf  contracts/   # needs weasyprint/wkhtmltopdf