diff --git a/README.md b/README.md index 3fbc69f..7c8f201 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,13 @@ macOS / Windows 微信聊天记录查看，AI 一键生成群聊总结。 在微信 4.0 数据库解析、解密思路上，项目参考了 [WeFlow](https://github.com/hicccc77/WeFlow) 等开源项目的实现方式；此项目围绕我自己的使用场景做的定制化工具，重点放在本地聊天记录查看、群聊总结和个人工作流集成上。 -> 当前版本：`v2.1.2`。macOS 支持相对稳定；Windows 已初步支持微信 4.0 数据库连接、自动获取密钥和聊天记录查看，仍在持续兼容不同微信版本与本地目录结构。 +> 当前版本：`v2.1.4`。macOS 支持相对稳定；Windows 可能会遇到性能 卡顿问题, 仍在持续兼容不同微信版本与本地目录结构。 ## ✨ 功能特性 - **聊天记录查看**: 浏览微信好友和群聊的聊天记录，支持头像显示。 - **全局搜索**: 快速搜索聊天内容。 +- **消息防撤回**: 高亮查看对方已撤回消息 - **AI 智能总结**: 支持多模型服务配置（DeepSeek/GPT-4o/Claude/Moonshot），一键总结群聊精华内容，生成话题报告。 - **群聊日报生成**: 支持围绕群聊内容生成日报，通常会覆盖以下模块中的部分或全部内容： - **今日讨论热点**: 梳理群内主要话题，支持热度标签。 @@ -51,42 +52,21 @@ macOS / Windows 微信聊天记录查看，AI 一键生成群聊总结。 ## [点击这里下载](https://github.com/Wxw-Gu/WechatExplorer/releases) -## 📦 安装说明 +## 📖 使用方法 -### macOS 版本已测 4.1.8 +安装、获取数据库密钥、连接微信数据及常见问题，请查看： -> 微信 macOS `4.1.8.100` 下载地址：[wechat-versions v4.1.8.100](https://github.com/zsbai/wechat-versions/releases/tag/4.1.8.100) +### [👉 WechatExplorer 完整使用教程](./docs/user-guide/getting-started.md) -1. 下载 Releases 中的 `xxx.dmg` 文件。 -2. 打开 DMG 并将应用拖动到 **Applications** (应用程序) 文件夹。 -3. 如果遇到“无法打开，因为开发者无法验证”的提示，请前往： - `系统设置 -> 隐私与安全性 -> 仍要打开`。 -4. 打开微信登录界面不要登录，然后点击获取密钥，提示登录 然后点击登录 自动获取密钥 +教程包含 macOS 与 Windows 的分步截图，以及数据目录、SIP、图片解密密钥和自动获取失败的排查方法。 -### Windows 版本已测 4.1.9 +> 微信 4.0+ 在 macOS / Windows 上已支持部分能力，目前仍在持续适配。如需其他成熟方案，也可参考 [WeFlow](https://github.com/hicccc77/WeFlow) 和 [Chatlog](https://github.com/sjzar/chatlog)。 -> 微信 Windows `4.1.9.57` 下载地址：[wechat-win-archive v4.1.9.57](https://github.com/iibob/wechat-win-archive/releases#release-v4.1.9.57) +## 🛠️ 开发配置（可选） -1. 下载 Releases 中的 `xxx-setup.exe` 安装包。 -2. 双击安装，可按安装向导选择安装目录。 -3. 打开微信登录界面不要登录，然后点击获取密钥，提示登录 然后点击登录 自动获取密钥。 +本地开发需要 Node.js（推荐 v16+）和 pnpm 7。 -> Windows 支持仍处于初步阶段。软件会有些卡顿, 如果自动获取密钥失败，请先确认微信客户端已登录并保持运行；不同微信安装路径、数据目录和权限环境可能仍需要继续适配。 - -## 🚀 快速开始 - -### 使用前置要求 - -- **微信版本**: - - 微信 4.0+: macOS / Windows 已支持部分能力，仍在持续迭代与兼容性验证中；如需更成熟的完整方案，推荐使用 [WeFlow](https://github.com/hicccc77/WeFlow) [Chatlog](https://github.com/sjzar/chatlog) -- **macOS 自动获取密钥**: 需要先关闭 SIP，操作方式见 [macOS 关闭 SIP 教程](./docs/mac-disable-sip.md)；关闭 SIP 会降低系统安全性，使用完成后建议重新开启。 -- 如无法获取本地数据库密码，则无法使用当前项目 -- Node.js (推荐 v16+) -- pnpm@7 -- 解密后的微信数据库文件 (`.db`) 和对应的密钥 -- AI API Key（支持 OpenAI 兼容 API，可选 DeepSeek/GPT/Claude/Moonshot 等） - -### 环境变量配置 (.env) +### 环境变量 可选配置项，可在 `.env` 文件中设置；本地开发时运行 `pnpm dev` 会在 `.env` 不存在时自动从 `.env.example` 复制一份。成品用户也可以直接在软件“设置”里填写或自动获取图片解密密钥。 @@ -100,20 +80,6 @@ macOS / Windows 微信聊天记录查看，AI 一键生成群聊总结。 | `VITE_AI_MODEL` | AI 模型 | `deepseek-chat` | | `VITE_FILTER_MSG_TYPES` | 过滤的消息类型 | `分享消息,图片,表情包,视频` | -#### 图片解密密钥说明 - -微信 4.0+ 的图片以 `.dat` 文件存储，需要密钥解密： - -- **XOR Key**: 单字节 hex 值（如 `0x40`），用于简单的字节异或解密 -- **AES Key**: 16字符字符串，用于 AES-128-ECB 解密 - -这两个密钥可以通过以下方式获取： - -1. 在应用登录界面点击“自动获取密钥” -2. 从 WeFlow/Chatlog 设置中导出 -3. 在软件“设置 -> 图片解密密钥”中自动获取或手动填写 -4. 如自动获取失败，可手动粘贴已获取的密钥 - ## 🤖 AI 集成（本地 HTTP API） WechatExplorer 内置了一个本地 HTTP API 服务，默认监听 `127.0.0.1:6131`（纯本地，无鉴权），让你能够从 **Claude Desktop / Claude Code / Codex / curl / 任何脚本** 读取已经解锁的微信聊天记录。 diff --git a/docs/user-guide/getting-started.md b/docs/user-guide/getting-started.md new file mode 100644 index 0000000..9d85b04 --- /dev/null +++ b/docs/user-guide/getting-started.md @@ -0,0 +1,121 @@ +# WechatExplorer 使用教程 + +本文介绍如何安装 WechatExplorer、自动获取微信数据库密钥，并完成首次连接。 + +## 1. 使用前准备 + +### 支持的版本 + +| 系统 | 已测试的微信版本 | 说明 | +| --- | --- | --- | +| macOS | `4.1.8.100` | 支持相对稳定；自动获取密钥前需要关闭 SIP | +| Windows | `4.1.9.57` | 已初步支持；不同安装路径和数据目录可能仍需手动调整 | + +- macOS 微信下载：[wechat-versions v4.1.8.100](https://github.com/zsbai/wechat-versions/releases/tag/4.1.8.100) +- Windows 微信下载：[wechat-win-archive v4.1.9.57](https://github.com/iibob/wechat-win-archive/releases#release-v4.1.9.57) +- WechatExplorer 下载：[GitHub Releases](https://github.com/Wxw-Gu/WechatExplorer/releases) + +> [!IMPORTANT] +> WechatExplorer 必须取得本机微信数据库密钥才能读取聊天记录。请仅处理你有权访问的数据。 + +### macOS：关闭 SIP + +macOS 自动获取密钥前需要关闭 SIP，具体操作见 [macOS 关闭 SIP 教程](../mac-disable-sip.md)。 + +关闭 SIP 会降低系统安全性。建议了解风险后再操作，并在不再需要自动获取密钥时重新开启。 + +## 2. 安装 WechatExplorer + +### macOS + +1. 从 Releases 下载 `.dmg` 文件。 +2. 打开 DMG，将 WechatExplorer 拖入“应用程序”文件夹。 +3. 如果系统提示“无法打开，因为开发者无法验证”，请前往“系统设置 → 隐私与安全性”，点击“仍要打开”。 +4. 如果系统提示应用已损坏，在终端执行： + + ```bash + xattr -cr "/Applications/WechatExplorer.app" + ``` + +### Windows + +1. 从 Releases 下载 `-setup.exe` 安装包。 +2. 双击安装，并按安装向导完成操作。 + +## 3. 自动获取密钥 + +### 第一步：确认微信数据目录 + +启动 WechatExplorer 后，先检查页面中的“存储路径”是否正确。 + +![确认微信数据目录](./images/initial-setup.png) + +Windows 当前不会扫描二级目录。如果没有正确识别微信数据，请进入“设置”，手动选择微信数据所在目录。 + +![Windows 自定义数据目录](./images/windows-data-path.png) + +### 第二步：让微信停留在登录页面 + +如果微信已经登录，请先退出登录；然后重新打开微信，让它停留在未登录页面，暂时不要点击登录。 + +![微信未登录页面](./images/wechat-login-window.png) + +### 第三步：开始获取密钥 + +返回 WechatExplorer，点击“自动获取密钥”。 + +- **Windows**：看到“Hook 注入成功”后，返回微信完成登录。 +- **macOS**：系统会弹出授权提示，请输入当前 macOS 用户密码并完成授权，然后返回微信完成登录。 + +![macOS 授权页面](./images/macos-authorization.png) + +> 点击“自动获取密钥”前，微信必须停留在登录页面。WechatExplorer 提示可以登录后，再回到微信完成登录。 + +### 第四步：完成连接 + +如果系统环境和微信版本符合要求，WechatExplorer 会自动填写数据库密钥并连接数据库。连接成功后即可查看、搜索和导出聊天记录，也可以配置 AI 服务生成群聊总结。 + +![密钥获取完成](./images/setup-complete.png) + +## 4. 图片解密密钥 + +微信 4.0 及以上版本的图片通常以 `.dat` 文件存储，显示图片还需要： + +- **XOR Key**：单字节十六进制值，例如 `0x40`。 +- **AES Key**：用于 AES-128-ECB 解密的 16 字符字符串。 + +可以通过以下方式配置： + +1. 使用首次连接页面的“自动获取密钥”。 +2. 在“设置 → 图片解密密钥”中自动获取或手动填写。 +3. 从 WeFlow 或 Chatlog 的设置中导出后手动填写。 + +数据库连接成功但图片无法显示时，请优先检查这两项密钥。 + +## 5. 常见问题 + +### 自动获取密钥失败 + +请依次确认： + +1. 微信版本是否与上方已测试版本一致。 +2. 点击“自动获取密钥”时，微信是否停留在未登录页面。 +3. 微信数据目录是否正确；Windows 用户尤其需要检查是否多选或少选了一层目录。 +4. macOS 是否已按教程关闭 SIP，并完成系统授权。 +5. 微信和 WechatExplorer 是否都保持运行。 + +仍然失败时，可以切换到“手动输入”，粘贴从其他兼容工具中取得的数据库密钥。 + +### Windows 使用时卡顿 + +Windows 支持仍处于初步阶段，不同微信版本、安装路径、数据目录和权限环境可能存在差异。建议优先使用上方已测试的微信版本。 + +### 数据会上传吗？ + +聊天数据库在本机读取和处理。只有使用 AI 总结功能时，相关聊天内容才会按你配置的模型服务发送；是否启用以及使用哪个服务由你决定。 + +## 6. 下一步 + +- 在应用“设置”中填写兼容 OpenAI API 的模型服务和 API Key，使用 AI 总结功能。 +- 在应用的 **API** 页面安装 Reader Skill，让 Codex 或 Claude Code 读取和总结本地群聊。 +- 本地 API 的端点和调试方法见项目 [README](../../README.md#ai-集成本地-http-api)。 diff --git a/docs/user-guide/images/initial-setup.png b/docs/user-guide/images/initial-setup.png new file mode 100644 index 0000000..6debfa6 Binary files /dev/null and b/docs/user-guide/images/initial-setup.png differ diff --git a/docs/user-guide/images/macos-authorization.png b/docs/user-guide/images/macos-authorization.png new file mode 100644 index 0000000..6f32863 Binary files /dev/null and b/docs/user-guide/images/macos-authorization.png differ diff --git a/docs/user-guide/images/setup-complete.png b/docs/user-guide/images/setup-complete.png new file mode 100644 index 0000000..75563a1 Binary files /dev/null and b/docs/user-guide/images/setup-complete.png differ diff --git a/docs/user-guide/images/wechat-login-window.png b/docs/user-guide/images/wechat-login-window.png new file mode 100644 index 0000000..b195e10 Binary files /dev/null and b/docs/user-guide/images/wechat-login-window.png differ diff --git a/docs/user-guide/images/windows-data-path.png b/docs/user-guide/images/windows-data-path.png new file mode 100644 index 0000000..e5d28d8 Binary files /dev/null and b/docs/user-guide/images/windows-data-path.png differ diff --git a/public/二维码.jpg b/public/二维码.jpg index 5974522..7d6527c 100644 Binary files a/public/二维码.jpg and b/public/二维码.jpg differ