SIREEN SIREEN
Documentation

SIREEN Docs

Everything you need to install, configure, and use SIREEN effectively.

Documentation Overview

Choose a topic below or use the sidebar to navigate.

Quick Start Guide

Install SIREEN, run your first audit, and interpret the results in under 10 minutes.

 Core Concepts

Learn what attack hypotheses, PoCs, terminal states, and evidence packs mean.

 CLI Reference

Complete command reference for the SIREEN CLI.

 AI-Assisted Mode

Enable optional AI exploration with a free OpenRouter key.

 Known Limitations

Understand what SIREEN can and cannot do today.

 FAQ

Common questions and answers.

Quick Command Reference

# Audit a single file
sireen audit ./Contract.sol
sireen audit ./Contract.sol --json
sireen audit ./Contract.sol --report

# Audit a full project
sireen audit ./my-foundry-project --project

# Inspect results
sireen audits
sireen show <audit-id>
sireen report <audit-id> --output report.md

# Start backend server (for VS Code)
python -m uvicorn main:app --host 127.0.0.1 --port 7432
New to SIREEN?

Start with the Getting Started Guide for a step-by-step walkthrough of your first audit.