Documentation menu

Install OpenOSINT

One command

pip install openosint

OpenOSINT needs Python 3.10 or newer. It starts with no API keys and no .env file; keyless tools work immediately.

Other ways to install

Method Command
pipx (isolated CLI) pipx install openosint
uv, installed uv tool install openosint
uv, no install uvx openosint web
From source git clone https://github.com/OpenOSINT/OpenOSINT.git, then pip install -e . inside it
Docker docker compose up --build from a source checkout; the web UI is then at http://localhost:8080

With Docker, one-off commands run as docker compose run --rm openosint email target@example.com --json. Reports go to ./reports/; the graph database and session history live in the openosint-data volume.

Optional extras

Install an extra with pip install "openosint[name]".

Extra Adds
ollama Local models through Ollama
openai Any OpenAI-compatible endpoint
shodan, censys The Shodan and Censys API clients
socks SOCKS proxy support
graph The FollowTheMoney library for .ftm export (builds PyICU, needs libicu and a C++ compiler)
graph-dedup Same-entity scoring for the graph (Python 3.11+)

External programs

Four tools call a separate program, which must be on your PATH. They are noisy or unverified, so they are off until you pass --allow-active (see Safety).

Tool Program Install
search_email holehe pip install holehe
search_username sherlock pip install sherlock-project
search_domain sublist3r pip install sublist3r
search_phone phoneinfoga see its project page

The Docker image already includes holehe, sherlock and sublist3r.

Check that it works

openosint --help
openosint dns example.com

--help lists every command. The dns lookup needs no key and no AI provider; it prints the domain's records and its SPF and DMARC analysis. There is no --version flag: run pip show openosint, or look at the banner when you start the REPL.

Next

Run your first investigation.

Edit this page on GitHub