OpenOSINT

(β˜… 1,440)

AI-powered OSINT agent with interactive REPL, MCP server, and CLI. 19 tools. Works with Claude, GPT-4, or local models. For authorized security research only.

File Explorer

Download Latest Version (.zip)
  • .env.example
  • .gitignore
  • .python-version
  • CHANGELOG.md
  • CLA.md
  • CLOUD.md
  • COMMERCIAL-LICENSE.md
  • COMMERCIAL.md
  • CONTRIBUTING.md
  • DISCLAIMER.md
  • docker-compose.yml
  • Dockerfile
  • glama.json
  • LICENSE
  • llms.txt
  • Makefile
  • openosint.tape
  • openosint_demo.py
  • PLAN.md
  • PLAN_PLAYBOOKS_2.md
  • Procfile
  • Procfile.demo
  • pyproject.toml
  • README.md
  • SECURITY.md
  • sponsors.json
  • SPONSORS.md
  • SPONSORSHIP.md
  • uv.lock
  • web-demo-edit.gif

# Installation Guide

1. Get the code
git clone https://github.com/OpenOSINT/OpenOSINT

Downloads the entire project code from GitHub to your computer.

cd OpenOSINT

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install openosint

Installs the package published on PyPI directly β€” no need to clone the source.

pip install "openosint[web]"

Installs the package published on PyPI directly β€” no need to clone the source.

pip install "openosint[openai]"

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

docker compose run --rm openosint email target@example.com --json

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd scripts/record-demo

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install openosint

Installs the package published on PyPI directly β€” no need to clone the source.

pip install "openosint[web]"

Installs the package published on PyPI directly β€” no need to clone the source.

pip install "openosint[openai]"

Installs the package published on PyPI directly β€” no need to clone the source.

pip install -e .

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

6. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make demo # record -> encode -> write docs/assets/demo-web-graph.*

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

Today's picks

supabase β˜… 108,234

The Postgres development platform. Supabase gives you a dedicated Postgres database to bui

TypeScript
gitignore β˜… 175,385

A collection of useful .gitignore templates
cs-video-courses β˜… 83,137

List of Computer Science courses with video lectures.
TradingAgents β˜… 99,131

TradingAgents: Multi-Agents LLM Financial Trading Framework

Python
clean-code-javascript β˜… 94,761

Clean Code concepts adapted for JavaScript

JavaScript
opencv β˜… 90,538

Open Source Computer Vision Library

C++
// repository documentation