maigret README

The project's README from github.com/soxoj/maigret. As one markdown file: README.md.

Maigret

PyPI version badge for Maigret Total downloads Downloads/month
View count for Maigret project Minimum Python version required: 3.10+ License badge for Maigret

Maigret logo

Ask Code Wiki about Maigret Ask DeepWiki about Maigret

English · 简体中文

Maigret collects a dossier on a person by username only, checking for accounts on a huge number of sites and gathering all the available information from web pages. No API keys required. AI profiling (demo).

Sponsors

IPcook

IPcook provides reliable residential proxies for online research, username discovery, and public data collection workflows. High success rates • 99.99% uptime • Response time under 0.5s • Monthly & Pay-as-you-go • Non-expiring traffic • Up to 10 free sub-accounts for team collaboration • Residential proxies from $0.3–$3.2/GB.
Special Offer: FREE 100MB trial available. Use code WELCOME20 for 20% off.


RapidProxy

RapidProxy provides high-performance residential proxies for Twitter scraping, Selenium automation, and web data extraction. 90M+ IPs • Smart rotation • Anti-block • Non-expiring traffic.
Special Offer: Try it free — Plans from $0.65/GB. Use code RAPID10 for 10% off.

MangoProxy

MangoProxy is a Residential, ISP, Mobile and Datacenter proxy service designed for professional tasks where stability, speed, and anonymity matter.
Promo code: SOXOJ - 8% off Static ISP proxies

Contents

In one minute

Ensure you have Python 3.10 or higher.

pip install maigret
maigret YOUR_USERNAME

No install? Try the community Telegram bot or a Cloud Shell.

Want a web UI? See how to launch it.

See also: Quick start.

Main features

For the complete feature list, see the features documentation.

Used by

Professional OSINT and social-media analysis tools built on Maigret:

Social Links API Social Links Crimewall UserSearch

Demo

Video

asciicast

Reports

PDF report, HTML report

HTML report screenshot

XMind 8 report screenshot

Full console output

Installation

Already ran the In one minute steps? You're set. Below are alternative methods.

Don't want to install anything? Use the community Telegram bot.

Windows

Download maigret_standalone.exe from Releases. You can launch it two ways:

cd %USERPROFILE%\Downloads
maigret_standalone.exe USERNAME
maigret_standalone.exe USERNAME --html       :: also save an HTML report
maigret_standalone.exe --help                :: list all options

Video guide: https://youtu.be/qIgwTZOmMmM.

Cloud Shells

Run Maigret in the browser via cloud shells or Jupyter notebooks:

Open in Cloud Shell Run on Replit

Open In Colab Open In Binder

Snap (Linux)

Get it from the Snap Store

sudo snap install maigret

# usage
maigret username

Available for amd64 and arm64, no Python required. The snap is strictly confined and can write inside your home directory, so run it from there. For USB drives, connect the interface once with sudo snap connect maigret:removable-media.

Local installation (pip)

# install from pypi
pip3 install maigret

# usage
maigret username

From source

# or clone and install manually
git clone https://github.com/soxoj/maigret && cd maigret

# build and install
pip3 install .

# usage
maigret username

Docker

Two image variants are published:

# official image (CLI)
docker pull soxoj/maigret

# CLI usage
docker run -v /mydir:/app/reports soxoj/maigret:latest username --html

# Web UI (open http://localhost:5000)
docker run -p 5000:5000 soxoj/maigret:web

# Web UI on a custom port
docker run -e PORT=8080 -p 8080:8080 soxoj/maigret:web

# manual build
docker build -t maigret .                  # CLI image (default target)
docker build --target web -t maigret-web . # Web UI image

Troubleshooting

Build errors? See the troubleshooting guide.

PDF reports (--pdf) are an optional extra — install with pip install 'maigret[pdf]'. They need system-level graphics libraries on Linux/macOS; see the PDF reports section for per-OS install steps.

Usage

Examples

# make HTML, PDF, and XMind reports
maigret user --html
maigret user --pdf
maigret user --xmind # legacy XML with a manifest for XMind 2022+ readers

# machine-readable exports
maigret user --json ndjson   # newline-delimited JSON (also: --json simple)
maigret user --csv
maigret user --txt
maigret user --graph         # interactive D3 graph (HTML)
maigret user --neo4j         # Neo4j Cypher script (graph database)

# search on sites marked with tags photo & dating
maigret user --tags photo,dating

# search on sites marked with tag us
maigret user --tags us

# highlight sites whose page also mentions specific keywords
maigret user --keywords python rust
# keyword-matched sites are shown with "[++]" in bright green

# search for three usernames on all available sites
maigret user1 user2 user3 -a

# AI-assisted investigation summary (needs OPENAI_API_KEY)
maigret user --ai

--neo4j writes a *_neo4j.cypher script of the results graph; import it with cypher-shell -u neo4j -p <password> < report_user_neo4j.cypher or paste it into the Neo4j Browser. Re-imports are idempotent. See the Neo4j export docs.

Run maigret --help for all options. Docs: CLI options, more examples. Running into 403s or timeouts? See TROUBLESHOOTING.md.

Web interface

Maigret has a built-in web UI with a results graph and downloadable reports.

Don't want to run it yourself? Deploy the published soxoj/maigret:web Docker image as a hosted app in one click:

Deploy to Render

Runs on Render's free tier (spins down after 15 min idle, spins back up on the next request). No login is set up on the instance, so anyone with the URL can use it.

Web Interface Screenshots

Web interface: how to start

Web interface: results

maigret --web 5000

Open http://127.0.0.1:5000, enter a username, and view results.

Python library

Maigret can be embedded in your own Python projects. The CLI is a thin wrapper around an async function you can call directly — build custom pipelines, feed results into your own tooling, or run it inside a larger OSINT workflow.

See the full library usage guide for a working example, async patterns, and how to filter sites by tag.

Useful CLI flags

AI analysis

asciicast

--ai collects the search results, builds an internal Markdown report, and sends it to an OpenAI-compatible chat completion endpoint to produce a short, neutral investigation summary (likely real name, location, occupation, interests, languages, confidence, follow-up leads). Per-site progress is suppressed and the model's output is streamed to stdout.

export OPENAI_API_KEY=sk-...
maigret user --ai

# pick a different model
maigret user --ai --ai-model gpt-4o-mini

The key can also be set as openai_api_key in settings.json. The endpoint defaults to https://api.openai.com/v1, but openai_api_base_url in settings.json can point to any OpenAI-compatible API (Azure OpenAI, OpenRouter, a local server, …). See the settings docs for the full list of options.

Tor / I2P / proxies

Maigret can route checks through a proxy, Tor, or I2P — useful for .onion / .i2p sites and for bypassing WAFs that block datacenter IPs.

# any HTTP/SOCKS proxy
maigret user --proxy socks5://127.0.0.1:1080

# Tor (default gateway socks5://127.0.0.1:9050)
maigret user --tor-proxy socks5://127.0.0.1:9050

# I2P (default gateway http://127.0.0.1:4444)
maigret user --i2p-proxy http://127.0.0.1:4444

Start your Tor / I2P daemon before running the command — Maigret does not manage these gateways.

Cloudflare bypass

Experimental. The Cloudflare webgate is under active development; the configuration schema, CLI behaviour, and the set of routed sites may change without backwards-compatibility guarantees.

A subset of sites in the database require a real browser to solve a JavaScript challenge. Maigret can offload these checks to a local FlareSolverr instance:

docker run -d -p 8191:8191 --name flaresolverr ghcr.io/flaresolverr/flaresolverr:latest
maigret --cloudflare-bypass <username>

The bypass is opt-in (--cloudflare-bypass or cloudflare_bypass.enabled in settings.json) and only fires for sites whose protection field matches. See the feature docs for backend options and configuration.

Contributing

Add or fix new sites surgically in data.json (no json.load/json.dump), then run ./utils/update_site_data.py to regenerate sites.md and the database metadata, and open a pull request. For more details, see the CONTRIBUTING guide and development docs. Release history: CHANGELOG.md.

Commercial Use

The open-source Maigret is MIT-licensed and free for commercial use without restriction — but site checks break over time and need active maintenance.

For serious commercial use — with a daily-updated site database or a username-check API — reach out: 📧 [email protected]

About

Disclaimer

For educational and lawful purposes only. You are responsible for complying with all applicable laws (GDPR, CCPA, etc.) in your jurisdiction. The authors bear no responsibility for misuse.

Feedback

Open an issue · GitHub Discussions · Telegram

SOWEL classification

OSINT techniques used:

License

MIT © Maigret

maigret (soxoj/maigret)

Searching Database…

39.2K ·GitHub
这是什么?Maigret 是一款 OSINT 命令行工具,它会在数千个网站上检查某个用户名是否有账号,并汇总能找到的所有资料,构建关于某人的档案。无需 API 密钥。
这是命令行工具,还是也有网页界面?它主要是一款 Python 命令行工具,但内置了网页界面,可以以图谱形式浏览结果;也可以作为库导入,在你自己的 Python 脚本中运行搜索。
怎么让它跑起来?Windows 用户可以从 Releases 下载独立版 maigretstandalone.exe;Linux 上有无需安装 Python 的 Snap 包;此外也可以运行 `pip install maigret`、从源码构建,或使用已发布的 Docker 镜像 `soxoj/maigret:latest` 或 `:web`。
运行它需要 Python 或 API 密钥吗?使用 pip 或源码安装需要 Python 3.10+(Windows exe 和 Snap 版本不需要);正常扫描不需要 API 密钥,只有可选的 AI 摘要模式需要一个兼容 OpenAI 的 API 密钥。
所有网站的检查长期都可靠吗?不可靠。目标网站一改版,检查就可能失效,因此公共数据库需要持续维护。部分网站要求真实浏览器通过 Cloudflare 的 JS 验证,目前只能通过实验性的 FlareSolverr 绕过方案处理。
网站数据库从哪里来?需要联网吗?它每 24 小时从 GitHub 自动更新网站列表;离线时会退回到内置数据库。查询敏感信息时,还可以通过 Tor、I2P 或代理转发检查请求。
默认扫描实际会检查多少个网站?在 3000 多个网站的数据库中,默认只检查流量最高的 500 个。使用 -a 可扫描全部网站,使用 --tags 可按类别或国家筛选。
Maigret 能找到我提供的用户名之外的账号吗?可以。它会进行递归搜索:在一个资料页上发现的用户名和其他 ID 会被自动用于查找更多账号。
--ai 参数有什么作用?它会把收集到的结果发送到兼容 OpenAI 的聊天接口,并流式返回一段简短、中立的调查摘要,内容包括可能的身份、所在地、职业以及后续线索。
可以导出哪些报告格式?Maigret 可以输出 PDF 和 HTML 报告,以及完整的控制台文本;网页界面则允许你在同一页面下载所有报告格式。
Creator
soxoj
Size
29.7 MB
Stars
39.2K
Age
6y
Commits · 90 Days