Get SIREEN v0.1.1

Run audits from the terminal. Best for scripting, CI pipelines, and batch analysis of multiple contracts or entire Foundry projects.

What it does

• Accepts a single .sol file or a full Foundry project directory
• Discovers functions, state variables, and external-call sites
• Generates attack hypotheses (heuristic or AI-assisted)
• Produces Foundry PoC test files for supported vectors
• Compiles and executes PoCs with forge test (when Forge is available)
• Persists audits in a local SQLite database
• Exports Markdown and JSON reports with evidence IDs

Prerequisites

Step 1 — Clone and install

git clone https://github.com/0766243478/goalaif.git
cd goalaif/gaolaif/backend
python -m pip install -r requirements.txt
python -m pip install -e .

This installs the sireen command into your Python environment. If Python's Scripts directory is on your PATH, you can use sireen directly. Otherwise, use python -m sireen_cli.

Step 2 — Configure your API key (optional)

SIREEN works fully offline without an API key. Adding one enables AI-assisted hypothesis generation, which can suggest additional attack angles beyond heuristic patterns.

You can use any LLM API key — OpenRouter accepts keys from OpenAI, Anthropic, Google, DeepSeek, and others. You are not locked into one provider.

cd goalaif/gaolaif/backend
cp .env.example .env.local

Edit .env.local and add your key:

# In .env.local
OPENROUTER_API_KEY=sk-or-v1-YOUR-KEY-HERE

Get a free key at openrouter.ai, or link an existing provider key. Free-tier models are used by default.

Step 3 — Run your first analysis

sireen audit ./MyContract.sol --report

Audit a full Foundry project:

sireen audit ./my-foundry-project --project --json

Step 4 — View findings and evidence

sireen audit ./MyContract.sol --json            # Full JSON output
sireen audits                                   # List past audits
sireen show <audit-id>                          # Show one audit
sireen report <audit-id> --output report.md     # Export Markdown

Troubleshooting

Analyze Solidity code directly inside your editor. The extension connects to the local SIREEN backend and displays findings, evidence packs, and live audit progress.

Current status

Prerequisites

Step 1 — Install the backend

The extension is a frontend only. You must have the SIREEN backend running locally. Follow the CLI installation steps above to set up the backend.

Step 2 — Obtain the extension

Method A — Install the pre-built .vsix:

Download sireen-0.1.4.vsix

Then install it:

code --install-extension sireen-0.1.4.vsix

Or via the VS Code UI: Extensions view (Ctrl+Shift+X) → ... menu → Install from VSIX...

SHA-256: d01d33c6de0b3f1db668803dc106e31d4d2bec291e64c06cc32cf7c6e919a6da
Size: 128,229 bytes (125 KB)

Method B — Build from source:

cd goalaif/gaolaif/extension
npm install
npm run compile
# Press F5 in VS Code to open the Extension Development Host

Step 3 — Start the backend

cd goalaif/gaolaif/backend
python -m uvicorn main:app --host 127.0.0.1 --port 7432

Step 4 — Open a Solidity project and analyze

1. Open any folder containing .sol files (a Foundry project works best).
2. Open a .sol file in the editor.
3. Right-click and select Sireen: Analyze Current File.

Step 5 — Review findings and evidence

Results appear in the Sireen sidebar. You will see:

• Findings list — category, severity estimate, and verdict
• Evidence packs — PoC source, reproduction steps, Forge output
• Terminal state — CONFIRMED, DEGRADED, CLEAN_WITH_COVERAGE, etc.