Setup

Install, verify, and run your first Silinosic-X workflows

Silinosic-X is packaged for pip install silinosic-x. Use the installed CLI as silinosic-x, and import it inside Python code as silinosic_x. A source checkout still makes sense for contributors.

Installation

Package install is the primary path

shell

pip install silinosic-x
silinosic-x --about
silinosic-x doctor
python -m silinosic_x --about
python -c "import silinosic_x"

What gets installed

The runtime depends on aiohttp, cryptography, Pillow, scapy, and rich. Reporter-rich artifacts also use matplotlib, python-docx, and reportlab. Developer extras add pytest, ruff, mypy, build, and twine.

requires Python >= 3.11 supports 3.11, 3.12, 3.13 in CI package: silinosic-x entrypoint: silinosic-x import: silinosic_x

Source checkout is still useful

Clone the repository when you want to contribute, inspect internals, or run local development tooling. For normal operator use, the docs now treat silinosic-x as the default command.

Optional developer tooling

shell

pip install -r requirements-dev.txt
pip install ".[reports]"
pip install ".[ocr]"
python -m pytest -q
python -m ruff check .
python -m mypy

Prerequisites

Know what is required, optional, and planned

Required today

Python 3.11+ and the standard runtime dependencies from requirements.txt. That is enough for the main CLI, profile/surface/fusion workflows, and most local documentation flows.

Optional today

Docker and Docker Compose for the runner scripts, plus Tor/proxy configuration if you want anonymity-aware routing. OCR can use easyocr or pytesseract, but pytesseract still depends on a reachable tesseract binary. Reporter now records what OCR/image tooling was actually available during the run.

Important expectation

Use the framework only for legal and authorized investigations. The README, security docs, and project notes all assume approved scope and responsible use.

First run

Prompt mode is the fastest way to learn the surface area

Start prompt mode

shell

silinosic-x

First commands to tryhelp, show plugins, show filters, enable plugin threat_conductor, config, profile alice.
Why this helpsThe prompt exposes aliases, help surfaces, explain text, defaults, and inventory counts in one place.

Run direct commands

shell

silinosic-x profile alice --html --plugin threat_conductor
silinosic-x surface example.com --html --module source-pack-01-module-1
silinosic-x fusion alice example.com --out-type json,html,sql,docx,pdf

Direct modeBetter for automation and repeatable scripts.
Prompt modeBetter for discovery, explain surfaces, and guided use.

Two smoke checks worth keeping

Use silinosic-x --about to verify the installed CLI, silinosic-x doctor to inspect local dependencies and OCR/Tor readiness, and silinosic-x quicktest if you want an offline sanity run against a bundled template.