Install

Aliens Eye is a Python package. It runs on Linux, macOS and Windows, and on Android under Termux, with Python 3.10 or newer.

#With pip

bash

pip install aliens-eye
aliens_eye --version

This installs the aliens_eye command and everything a scan needs. The ML model runs in pure Python, so scikit-learn, NumPy and a GPU are not needed to scan.

pipx install aliens-eye works too, and keeps the tool in its own environment.

#Optional extras

Some features need packages most people never use, so they are extras:

Extra	Adds	For
`browser`	Playwright	Rendering JavaScript-heavy pages when a result is Maybe (`--playwright`)
`correlate`	Pillow	Matching avatar images in `--correlate` (it works without, on names, bios and links)
`pdf`	reportlab	`--format pdf`
`tui`	Textual	The interactive terminal browser, `aliens_eye tui`
`serve`	mcp	The MCP server for LLM agents, `aliens_eye serve`
`train`	scikit-learn, NumPy	Retraining the detection model

bash

pip install "aliens-eye[browser]"
python -m playwright install chromium

pip install "aliens-eye[correlate,pdf,tui]"

The quotes stop shells such as zsh reading the square brackets as a pattern.

#With Docker

There is no published image; build it from the repository:

bash

git clone https://github.com/arxhr007/Aliens_eye.git
cd Aliens_eye
docker build -t aliens-eye .
docker run --rm -it aliens-eye username

The image runs as an unprivileged scanner user and writes reports to /home/scanner/results, which disappears with the container. To keep them, mount a directory there, running as your own user so the files are yours:

bash

mkdir -p results
docker run --rm -it --user "$(id -u):$(id -g)" \
    -v "$PWD/results:/home/scanner/results" aliens-eye username

#From source

bash

git clone https://github.com/arxhr007/Aliens_eye.git
cd Aliens_eye
pip install -e .

For development, with the test and lint tools, see Contributing.

#On Termux

bash

pkg install python
pip install aliens-eye

A full scan opens many connections at once. If the phone struggles, lower the concurrency with -c 20, or scan the smaller catalog with --catalog standard.

#Upgrading and uninstalling

bash

pip install --upgrade aliens-eye
pip uninstall aliens-eye

Uninstalling leaves your reports (in results/ wherever you ran a scan), your config.json, and the fingerprint cache in the platform cache directory (~/.cache/aliens_eye on Linux). Delete them by hand if you want them gone.

#Next

Usage walks through a first scan and how to read it.