Install

Sentinel is CLI-first. Local development, model review, and CI/CD checks use the same command set.

Definition

Sentinel installation prepares the CLI, scanner plugins, and optional API/web modules to run with the same rule ID language on Python 3.10+.

Requirements

Python 3.10+
Git access to the Sentinel repository
Enough disk space for model and archive scans

Install from source

git clone https://github.com/EresusSecurity/Eresus-sentinel.git
cd Eresus-sentinel
pip install -e ".[dev]"

Doctor

After installation, run the system health check first.

sentinel doctor

Doctor output is the first reference for Python version, plugin visibility, scanner modules, and optional binary dependencies.

GET STARTED

For the first real test, choose a small model directory. Before scanning large production model bundles, set size limits and output format intentionally.

Troubleshooting

Symptom	Check	Action
Command not found	`which sentinel`	Activate the virtual environment or repeat editable installation.
Large model scan is slow	`--max-file-size`	Set limits as policy and store SARIF/JSON output in CI.
Findings are noisy	Rule ID and FP risk	Gate CRITICAL/HIGH first and assign owners for MEDIUM findings.

Next step

The quickstart page shows the basic commands in one flow.

PreviousIntro NextQuickstart