CLI Reference

sireen audit

Run a security audit on a single Solidity file or a Foundry project directory.

sireen audit <path> [options]

Options:
  --json              Output full JSON report to stdout
  --report            Write a Markdown report to the working directory
  --project           Treat path as a Foundry project directory
  --output <file>     Write JSON output to a specific file

Examples

# Audit a single file with Markdown report
sireen audit ./MyContract.sol --report

# Audit with JSON output
sireen audit ./MyContract.sol --json

# Audit an entire Foundry project
sireen audit ./my-project --project --json

sireen audits

List all past audits stored in the local SQLite database.

sireen audits

sireen show

Display the full details of a specific audit, including evidence packs.

sireen show <audit-id>

sireen report

Export an existing audit as a Markdown report.

sireen report <audit-id> --output report.md

Exit Codes

Environment Variables