Skip to content

Installation

Requirements

  • Python >= 3.10
  • Internet access for online queries (optional in offline mode)

Windows (PowerShell)

python -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
pip install basiliskscan

Linux/macOS

python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
pip install basiliskscan

After installation, the bscan command is available. If your terminal doesn’t recognize it, open a new session or run via module:

python -m basiliskscan --help

Development install (local repo)

From the project directory:

python -m pip install -e .

Windows install script

The repository includes scripts/install_basiliskscan.ps1, which installs the project and updates the user PATH:

Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
.\scripts\install_basiliskscan.ps1 -Editable

Verify installation

bscan --version
bscan --help