docs: add Simplified Chinese README translation (#2606)

2026-05-06 14:08:59 +00:00 · 2026-05-03 16:35:15 +08:00
parent 8b5dce1d3c
commit ac1e3d33ec
2 changed files with 294 additions and 0 deletions
@@ -23,6 +23,10 @@
    <img src="https://raw.githubusercontent.com/soxoj/maigret/main/static/maigret.png" height="300" alt="Maigret logo"/>
  </div>
  <br>
+  <div>
+    <b>English</b> · <a href="README.zh-CN.md">简体中文</a>
+  </div>
+  <br>
 </div>

 **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.
@@ -0,0 +1,290 @@
+# Maigret
+
+<div align="center">
+  <div>
+    <a href="https://pypi.org/project/maigret/">
+        <img alt="Maigret 的 PyPI 版本" src="https://img.shields.io/pypi/v/maigret?style=flat-square" />
+    </a>
+    <a href="https://pypi.org/project/maigret/">  
+        <img alt="Maigret 的 PyPI 周下载量" src="https://img.shields.io/pypi/dw/maigret?style=flat-square" />
+    </a>
+    <a href="https://github.com/soxoj/maigret">
+        <img alt="所需最低 Python 版本:3.10+" src="https://img.shields.io/badge/Python-3.10%2B-brightgreen?style=flat-square" />
+    </a>
+    <a href="https://github.com/soxoj/maigret/blob/main/LICENSE">
+        <img alt="Maigret 的开源许可证" src="https://img.shields.io/github/license/soxoj/maigret?style=flat-square" />
+    </a>
+    <a href="https://github.com/soxoj/maigret">
+        <img alt="Maigret 项目访问量" src="https://komarev.com/ghpvc/?username=maigret&color=brightgreen&label=views&style=flat-square" />
+    </a>
+  </div>
+  <br>
+  <div>
+    <img src="https://raw.githubusercontent.com/soxoj/maigret/main/static/maigret.png" height="300" alt="Maigret logo"/>
+  </div>
+  <br>
+  <div>
+    <a href="README.md">English</a> · <b>简体中文</b>
+  </div>
+  <br>
+</div>
+
+**Maigret** 仅凭一个用户名,就能在大量站点上查找其账号,并从网页中收集所有可获取的公开信息,为目标人物生成一份档案。无需任何 API 密钥。
+
+## 目录
+
+- [一分钟上手](#one-minute)
+- [核心特性](#main-features)
+- [演示](#demo)
+- [安装](#installation)
+- [使用](#usage)
+- [参与贡献](#contributing)
+- [商业使用](#commercial-use)
+- [关于](#about)
+
+<a id="one-minute"></a>
+## 一分钟上手
+
+请先确认本机的 Python 版本不低于 3.10。
+
+```bash
+pip install maigret
+maigret YOUR_USERNAME
+```
+
+不想本地安装?可以试试 [Telegram 机器人](https://t.me/maigret_search_bot),或者使用[云端 Shell](#cloud-shells)。
+
+想要一个 Web 界面?参见[启动方式](#web-interface)。
+
+延伸阅读:[快速入门](https://maigret.readthedocs.io/en/latest/quick-start.html)。
+
+<a id="main-features"></a>
+## 核心特性
+
+- 支持 3000+ 站点(完整列表见 [sites.md](https://github.com/soxoj/maigret/blob/main/sites.md))。默认仅检查访问量排名前 500 的站点;加上 `-a` 可全量扫描,或使用 `--tags` 按分类/国家筛选。
+- 可作为 Python 库嵌入到自己的项目中——直接 `import maigret` 即可在代码里发起搜索(参见[库使用文档](https://maigret.readthedocs.io/en/latest/library-usage.html))。
+- 通过 [socid_extractor](https://github.com/soxoj/socid_extractor) 从个人主页和站点 API 中[提取](https://github.com/soxoj/socid_extractor)账号所有者的所有可获取信息,包括指向其他账号的链接。
+- 基于已发现的用户名和其他 ID,执行递归搜索。
+- 支持按标签(站点分类、国家)进行筛选。
+- 能够检测并部分绕过封锁、审查和 CAPTCHA。
+- 每次运行时(每 24 小时一次)从 GitHub 拉取一份[自动更新的站点数据库](https://maigret.readthedocs.io/en/latest/settings.html#database-auto-update);离线时会回退到内置数据库。
+- 可访问 Tor 与 I2P 站点;支持检查域名。
+- 自带一个 [Web 界面](#web-interface),可在同一页面将结果以图谱方式浏览,并下载各种格式的报告。
+
+完整特性列表请见[特性文档](https://maigret.readthedocs.io/en/latest/features.html)。
+
+### 谁在使用
+
+基于 Maigret 构建的专业 OSINT 与社交媒体分析工具:
+
+<a href="https://github.com/SocialLinks-IO/sociallinks-api"><img height="60" alt="Social Links API" src="https://github.com/user-attachments/assets/789747b2-d7a0-4d4e-8868-ffc4427df660"></a>
+<a href="https://sociallinks.io/products/sl-crimewall"><img height="60" alt="Social Links Crimewall" src="https://github.com/user-attachments/assets/0b18f06c-2f38-477b-b946-1be1a632a9d1"></a>
+<a href="https://usersearch.ai/"><img height="60" alt="UserSearch" src="https://github.com/user-attachments/assets/66daa213-cf7d-40cf-9267-42f97cf77580"></a>
+
+<a id="demo"></a>
+## 演示
+
+### 视频
+
+<a href="https://asciinema.org/a/Ao0y7N0TTxpS0pisoprQJdylZ">
+  <img src="https://asciinema.org/a/Ao0y7N0TTxpS0pisoprQJdylZ.svg" alt="asciicast" width="600">
+</a>
+
+### 报告示例
+
+[PDF 报告](https://raw.githubusercontent.com/soxoj/maigret/main/static/report_alexaimephotographycars.pdf)、[HTML 报告](https://htmlpreview.github.io/?https://raw.githubusercontent.com/soxoj/maigret/main/static/report_alexaimephotographycars.html)
+
+![HTML 报告截图](https://raw.githubusercontent.com/soxoj/maigret/main/static/report_alexaimephotography_html_screenshot.png)
+
+![XMind 8 报告截图](https://raw.githubusercontent.com/soxoj/maigret/main/static/report_alexaimephotography_xmind_screenshot.png)
+
+[完整的命令行输出示例](https://raw.githubusercontent.com/soxoj/maigret/main/static/recursive_search.md)
+
+<a id="installation"></a>
+## 安装
+
+如果你已经按[一分钟上手](#one-minute)的步骤跑通了,就无需再装。下面列出几种可选的安装方式。
+
+什么都不想装?直接用 [Telegram 机器人](https://t.me/maigret_search_bot)。
+
+### Windows
+
+从 [Releases](https://github.com/soxoj/maigret/releases) 下载独立的 EXE 文件。视频指引:https://youtu.be/qIgwTZOmMmM。
+
+<a id="cloud-shells"></a>
+### 云端 Shell
+
+通过云端 Shell 或 Jupyter Notebook 在浏览器里运行 Maigret:
+
+<a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=cloudshell-tutorial.md"><img src="https://user-images.githubusercontent.com/27065646/92304704-8d146d80-ef80-11ea-8c29-0deaabb1c702.png" alt="Open in Cloud Shell" height="50"></a>
+<a href="https://repl.it/github/soxoj/maigret"><img src="https://replit.com/badge/github/soxoj/maigret" alt="Run on Replit" height="50"></a>
+
+<a href="https://colab.research.google.com/gist/soxoj/879b51bc3b2f8b695abb054090645000/maigret-collab.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" height="45"></a>
+<a href="https://mybinder.org/v2/gist/soxoj/9d65c2f4d3bec5dd25949197ea73cf3a/HEAD"><img src="https://mybinder.org/badge_logo.svg" alt="Open In Binder" height="45"></a>
+
+### 本地安装(pip)
+
+```bash
+# 从 PyPI 安装
+pip3 install maigret
+
+# 使用
+maigret username
+```
+
+### 从源码安装
+
+```bash
+# 也可以克隆仓库后手动安装
+git clone https://github.com/soxoj/maigret && cd maigret
+
+# 构建并安装
+pip3 install .
+
+# 使用
+maigret username
+```
+
+### Docker
+
+官方提供两个镜像变体:
+
+- `soxoj/maigret:latest` —— CLI 模式(默认)
+- `soxoj/maigret:web` —— 自动启动 [Web 界面](#web-interface)
+
+```bash
+# 拉取官方镜像(CLI)
+docker pull soxoj/maigret
+
+# CLI 用法
+docker run -v /mydir:/app/reports soxoj/maigret:latest username --html
+
+# Web UI(在 http://localhost:5000 打开)
+docker run -p 5000:5000 soxoj/maigret:web
+
+# 自定义 Web UI 端口
+docker run -e PORT=8080 -p 8080:8080 soxoj/maigret:web
+
+# 手动构建
+docker build -t maigret .                  # CLI 镜像(默认 target)
+docker build --target web -t maigret-web . # Web UI 镜像
+```
+
+### 故障排查
+
+构建报错?请见[故障排查指南](https://maigret.readthedocs.io/en/latest/installation.html#troubleshooting)。
+
+<a id="usage"></a>
+## 使用
+
+### 示例
+
+```bash
+# 生成 HTML、PDF、XMind 8 报告
+maigret user --html
+maigret user --pdf
+maigret user --xmind # 与 XMind 2022+ 不兼容
+
+# 机器可读的导出格式
+maigret user --json ndjson   # 行分隔 JSON(也支持 --json simple)
+maigret user --csv
+maigret user --txt
+maigret user --graph         # 交互式 D3 图谱(HTML)
+
+# 仅在带有 photo 与 dating 标签的站点上搜索
+maigret user --tags photo,dating
+
+# 仅在带有 us 标签的站点上搜索
+maigret user --tags us
+
+# 同时在所有站点上搜索三个用户名
+maigret user1 user2 user3 -a
+```
+
+完整选项请运行 `maigret --help`。文档:[命令行选项](https://maigret.readthedocs.io/en/latest/command-line-options.html)、[更多示例](https://maigret.readthedocs.io/en/latest/usage-examples.html)。遇到 403 或超时?参见 [TROUBLESHOOTING.md](TROUBLESHOOTING.md)。
+
+<a id="web-interface"></a>
+### Web 界面
+
+Maigret 内置一个 Web UI,提供结果图谱视图和报告下载。
+
+<details>
+<summary>Web 界面截图</summary>
+
+![Web 界面:启动页](https://raw.githubusercontent.com/soxoj/maigret/main/static/web_interface_screenshot_start.png)
+
+![Web 界面:结果页](https://raw.githubusercontent.com/soxoj/maigret/main/static/web_interface_screenshot.png)
+
+</details>
+
+```console
+maigret --web 5000
+```
+
+在浏览器中打开 http://127.0.0.1:5000,输入用户名即可查看结果。
+
+### Python 库
+
+**Maigret 可以嵌入到你自己的 Python 项目里使用。** CLI 只是对一个异步函数的薄包装,你完全可以直接调用它——构建自定义流水线、把结果接入自家工具,或将其嵌入更大的 OSINT 工作流。
+
+完整示例(包含异步用法和按标签筛选站点)请参见[库使用指南](https://maigret.readthedocs.io/en/latest/library-usage.html)。
+
+### 常用 CLI 参数
+
+- `--parse URL` —— 解析一个个人主页,从中提取 ID/用户名,并以此为起点发起递归搜索。
+- `--permute` —— 基于两个或更多输入生成可能的用户名变体(例如 `john doe` → `johndoe`、`j.doe` …)并对其逐一搜索。
+- `--self-check [--auto-disable]` —— 维护者用于核对数据库的工具:针对线上站点验证 `usernameClaimed` / `usernameUnclaimed` 配对是否仍然有效。
+
+### Tor / I2P / 代理
+
+Maigret 支持通过代理、Tor 或 I2P 转发请求——这对访问 `.onion` / `.i2p` 站点,以及绕过会拦截数据中心 IP 的 WAF 都很有用。
+
+```bash
+# 任意 HTTP/SOCKS 代理
+maigret user --proxy socks5://127.0.0.1:1080
+
+# Tor(默认网关 socks5://127.0.0.1:9050)
+maigret user --tor-proxy socks5://127.0.0.1:9050
+
+# I2P(默认网关 http://127.0.0.1:4444)
+maigret user --i2p-proxy http://127.0.0.1:4444
+```
+
+请先启动 Tor / I2P 守护进程再运行上述命令——Maigret 不会替你管理这些网关。
+
+<a id="contributing"></a>
+## 参与贡献
+
+请精确地在 `data.json` 里新增或修复站点(不要使用 `json.load`/`json.dump` 整体读写),然后运行 `./utils/update_site_data.py` 重新生成 `sites.md` 和数据库元数据,再提交 Pull Request。更多细节见 [CONTRIBUTING 指南](https://github.com/soxoj/maigret/blob/main/CONTRIBUTING.md) 和[开发文档](https://maigret.readthedocs.io/en/latest/development.html)。版本历史见 [CHANGELOG.md](CHANGELOG.md)。
+
+<a id="commercial-use"></a>
+## 商业使用
+
+开源版本的 Maigret 采用 MIT 许可证,可不受限制地用于商业用途——但站点检查会随时间失效,需要持续维护。
+
+如果你有更严肃的商业需求——希望使用**每日更新的站点数据库**或**用户名查询 API**——欢迎联系:📧 [maigret@soxoj.com](mailto:maigret@soxoj.com)
+
+- 私有站点数据库 —— 5000+ 站点,每日更新(独立于公开开源数据库)
+- 用户名查询 API —— 将 Maigret 集成进你的产品
+
+<a id="about"></a>
+## 关于
+
+### 免责声明
+
+**仅供教育与合法用途。** 使用者需自行承担遵守所在司法辖区相关法律(GDPR、CCPA 等)的责任。作者不对任何滥用行为负责。
+
+### 反馈
+
+[提交 issue](https://github.com/soxoj/maigret/issues) · [GitHub Discussions](https://github.com/soxoj/maigret/discussions) · [Telegram](https://t.me/soxoj)
+
+### SOWEL 分类
+
+涉及到的 OSINT 技术:
+- [SOTL-2.2. Search For Accounts On Other Platforms](https://sowel.soxoj.com/other-platform-accounts)
+- [SOTL-6.1. Check Logins Reuse To Find Another Account](https://sowel.soxoj.com/logins-reuse)
+- [SOTL-6.2. Check Nicknames Reuse To Find Another Account](https://sowel.soxoj.com/nicknames-reuse) 
+
+### 许可证
+
+MIT © [Maigret](https://github.com/soxoj/maigret)