From 2d5832d6a9c1393575253d8fb7f2871dd635c5f7 Mon Sep 17 00:00:00 2001 From: cc <98377878+hicccc77@users.noreply.github.com> Date: Sun, 10 May 2026 12:04:18 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 175 ++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 130 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 101e08e..2c2d9ee 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ WeFlow 是一个**完全本地**的微信**实时**聊天记录查看、分析与导出工具。它可以实时获取你的微信聊天记录并将其导出，还可以根据你的聊天记录为你生成独一无二的分析报告。 -WeFlow is a fully local tool for viewing, analyzing, and exporting WeChat chat history in real time. It generates unique analysis reports based on your chat history. +--- + +**WeFlow** is a fully local tool for viewing, analyzing, and exporting WeChat chat history in real time. It generates unique analysis reports based on your chat history.

WeFlow 应用预览 @@ -28,99 +30,182 @@ WeFlow is a fully local tool for viewing, analyzing, and exporting WeChat chat h > > Only supports WeChat **version 4.0 and above**. Please ensure your WeChat version meets the requirements. -## 主要功能 | Key Features +## 主要功能 -- 本地实时查看聊天记录 | View chat history locally in real-time -- 朋友圈图片、视频、**实况**的预览和解密 | Preview and decrypt Moments photos, videos, and **Live Photos** -- 统计分析与群聊画像 | Statistical analysis and group chat insights -- 年度报告与可视化概览 | Annual reports and visual overviews -- 导出聊天记录为 HTML 等格式 | Export chat history to HTML and other formats -- HTTP API 接口（供开发者集成）| HTTP API interface (for developer integration) -- 查看完整能力清单：[详细功能](#详细功能清单--detailed-feature-list) | View complete feature list: [Detailed Features](#详细功能清单--detailed-feature-list) +- 本地实时查看聊天记录 +- 朋友圈图片、视频、**实况**的预览和解密 +- 统计分析与群聊画像 +- 年度报告与可视化概览 +- 导出聊天记录为 HTML 等格式 +- HTTP API 接口（供开发者集成） +- 查看完整能力清单：[详细功能](#详细功能清单) -## 支持平台与设备 | Supported Platforms & Devices +--- -| 平台 Platform | 设备/架构 Device/Architecture | 安装包 Package | +**Key Features** + +- View chat history locally in real-time +- Preview and decrypt Moments photos, videos, and **Live Photos** +- Statistical analysis and group chat insights +- Annual reports and visual overviews +- Export chat history to HTML and other formats +- HTTP API (for developer integration) +- View complete feature list: [Detailed Features](#详细功能清单) + +## 支持平台与设备 + +| 平台 | 设备/架构 | 安装包 | |------|----------|--------| | Windows | Windows10+、x64（amd64） | `.exe` | -| macOS | Apple Silicon（M 系列 M series，arm64） | `.dmg` | -| Linux | x64 devices (amd64) | `.AppImage`、`.tar.gz` | +| macOS | Apple Silicon（M 系列，arm64） | `.dmg` | +| Linux | x64 设备（amd64） | `.AppImage`、`.tar.gz` | -## 快速开始 | Quick Start +--- + +**Supported Platforms & Devices** + +| Platform | Device/Architecture | Package | +|----------|---------------------|---------| +| Windows | Windows 10+, x64 (amd64) | `.exe` | +| macOS | Apple Silicon (M series, arm64) | `.dmg` | +| Linux | x64 devices (amd64) | `.AppImage`, `.tar.gz` | + +## 快速开始 若你只想使用成品版本，可前往 [Releases](https://github.com/hicccc77/WeFlow/releases) 下载并安装。 +> ArchLinux 用户可以选择 `yay -S weflow` 快速安装 + +--- + +**Quick Start** + If you just want to use the pre-compiled application, go to [Releases](https://github.com/hicccc77/WeFlow/releases) to download and install. -> ArchLinux 用户可以选择 `yay -S weflow` 快速安装 -> > ArchLinux users can quickly install with `yay -S weflow` -## 详细功能清单 | Detailed Feature List +## 详细功能清单 当前版本已支持以下能力： +| 功能模块 | 说明 | +|---------|------| +| **聊天** | 解密聊天中的图片、视频、实况（仅支持谷歌协议拍摄的实况）；支持**修改**、删除**本地**消息；实时刷新最新消息，无需生成解密中间数据库 | +| **消息防撤回** | 防止其他人发送的消息被撤回 | +| **实时弹窗通知** | 新消息到达时提供桌面弹窗提醒，便于及时查看重要会话，提供黑白名单功能 | +| **私聊分析** | 统计好友间消息数量；分析消息类型与发送比例；查看消息时段分布等 | +| **群聊分析** | 查看群成员详细信息；分析群内发言排行、活跃时段和媒体内容 | +| **年度报告** | 生成按年统计的年度报告，或跨年度的长期历史报告 | +| **双人报告** | 选择指定好友，基于双方聊天记录生成专属分析报告 | +| **消息导出** | 将微信聊天记录导出为多种格式：JSON、HTML、TXT、Excel、CSV、PGSQL、ChatLab专属格式等 | +| **朋友圈** | 解密朋友圈图片、视频、实况；导出朋友圈内容；拦截朋友圈的删除与隐藏操作；突破时间访问限制 | +| **联系人** | 导出微信好友、群聊、公众号信息；尝试找回曾经的好友（功能尚不完善） | +| **HTTP API 映射** | 将本地消息能力映射为 HTTP API，便于对接外部系统、自动化脚本与二次开发 | + +--- + +**Detailed Feature List** + The current version supports the following capabilities: -| 功能模块 Feature Module | 说明 Description | -|---------|------| -| **聊天 Chat** | 解密聊天中的图片、视频、实况（仅支持谷歌协议拍摄的实况）；支持**修改**、删除**本地**消息；实时刷新最新消息，无需生成解密中间数据库
Decrypt images, videos, and Live Photos in chats (only supports Live Photos captured with Google protocol); supports **modifying** and deleting **local** messages; real-time refresh of latest messages without generating decrypted intermediate databases | -| **消息防撤回 Anti-Recall** | 防止其他人发送的消息被撤回
Prevent messages sent by others from being recalled | -| **实时弹窗通知 Real-time Notifications** | 新消息到达时提供桌面弹窗提醒，便于及时查看重要会话，提供黑白名单功能
Desktop popup notifications when new messages arrive, convenient for timely viewing of important conversations, with blacklist/whitelist functionality | -| **私聊分析 Private Chat Analysis** | 统计好友间消息数量；分析消息类型与发送比例；查看消息时段分布等
Statistics on message counts between friends; analysis of message types and sending ratios; view message time distribution, etc. | -| **群聊分析 Group Chat Analysis** | 查看群成员详细信息；分析群内发言排行、活跃时段和媒体内容
View detailed group member information; analyze group activity rankings, active periods, and media content | -| **年度报告 Annual Report** | 生成按年统计的年度报告，或跨年度的长期历史报告
Generate annual reports by year, or long-term historical reports across years | -| **双人报告 Duo Report** | 选择指定好友，基于双方聊天记录生成专属分析报告
Select a specific friend and generate an exclusive analysis report based on your mutual chat history | -| **消息导出 Message Export** | 将微信聊天记录导出为多种格式：JSON、HTML、TXT、Excel、CSV、PGSQL、ChatLab专属格式等
Export WeChat chat history to multiple formats: JSON, HTML, TXT, Excel, CSV, PGSQL, ChatLab proprietary format, etc. | -| **朋友圈 Moments** | 解密朋友圈图片、视频、实况；导出朋友圈内容；拦截朋友圈的删除与隐藏操作；突破时间访问限制
Decrypt Moments photos, videos, and Live Photos; export Moments content; intercept deletion and hiding operations in Moments; bypass time-based access restrictions | -| **联系人 Contacts** | 导出微信好友、群聊、公众号信息；尝试找回曾经的好友（功能尚不完善）
Export WeChat friends, group chats, and official account information; attempt to recover deleted friends (work in progress) | -| **HTTP API 映射 HTTP API** | 将本地消息能力映射为 HTTP API，便于对接外部系统、自动化脚本与二次开发
Map local message capabilities to HTTP API for easy integration with external systems, automation scripts, and secondary development | +| Feature Module | Description | +|----------------|-------------| +| **Chat** | Decrypt images, videos, and Live Photos in chats (only supports Live Photos captured with Google protocol); supports **modifying** and deleting **local** messages; real-time refresh of latest messages without generating decrypted intermediate databases | +| **Anti-Recall** | Prevent messages sent by others from being recalled | +| **Real-time Notifications** | Desktop popup notifications when new messages arrive, convenient for timely viewing of important conversations, with blacklist/whitelist functionality | +| **Private Chat Analysis** | Statistics on message counts between friends; analysis of message types and sending ratios; view message time distribution, etc. | +| **Group Chat Analysis** | View detailed group member information; analyze group activity rankings, active periods, and media content | +| **Annual Report** | Generate annual reports by year, or long-term historical reports across years | +| **Duo Report** | Select a specific friend and generate an exclusive analysis report based on your mutual chat history | +| **Message Export** | Export WeChat chat history to multiple formats: JSON, HTML, TXT, Excel, CSV, PGSQL, ChatLab proprietary format, etc. | +| **Moments** | Decrypt Moments photos, videos, and Live Photos; export Moments content; intercept deletion and hiding operations in Moments; bypass time-based access restrictions | +| **Contacts** | Export WeChat friends, group chats, and official account information; attempt to recover deleted friends (work in progress) | +| **HTTP API** | Map local message capabilities to HTTP API for easy integration with external systems, automation scripts, and secondary development | ## HTTP API > [!WARNING] > 此功能目前处于早期阶段，接口可能会有变动，请等待后续更新完善。 -> -> This feature is currently in its early stages, and the interface may change. Stay tuned for future updates. WeFlow 提供本地 HTTP API 服务，支持通过接口查询消息数据，可用于与其他工具集成或二次开发。 +- **启用方式**：设置 → API 服务 → 启动服务 +- **默认端口**：5031 +- **访问地址**：`http://127.0.0.1:5031` +- **支持格式**：原始 JSON 或 [ChatLab](https://chatlab.fun/) 标准格式 + +完整接口文档：[点击查看](docs/HTTP-API.md) + +--- + +> [!WARNING] +> This feature is currently in its early stages, and the interface may change. Stay tuned for future updates. + WeFlow provides a local HTTP API service that supports querying message data through interfaces, which can be used for integration with other tools or secondary development. -- **启用方式 Enable Method**：设置 Settings → API 服务 API Service → 启动服务 Start Service -- **默认端口 Default Port**：5031 -- **访问地址 Access Address**：`http://127.0.0.1:5031` -- **支持格式 Supported Formats**：Raw JSON or [ChatLab](https://chatlab.fun/) standard format +- **Enable Method**: Settings → API Service → Start Service +- **Default Port**: 5031 +- **Access Address**: `http://127.0.0.1:5031` +- **Supported Formats**: Raw JSON or [ChatLab](https://chatlab.fun/) standard format -完整接口文档 Complete API documentation：[点击查看 Click to view](docs/HTTP-API.md) +Complete API documentation: [Click to view](docs/HTTP-API.md) -## 面向开发者 | For Developers +## 面向开发者 如果你想从源码构建或为项目贡献代码，请遵循以下步骤： +```bash +# 1. 克隆项目到本地 +git clone https://github.com/hicccc77/WeFlow.git +cd WeFlow + +# 2. 安装项目依赖 +npm install + +# 3. 运行应用（开发模式） +npm run dev +``` + +--- + +**For Developers** + If you want to build from source or contribute code to the project, please follow these steps: ```bash -# 1. 克隆项目到本地 | Clone the project locally +# 1. Clone the project locally git clone https://github.com/hicccc77/WeFlow.git cd WeFlow -# 2. 安装项目依赖 | Install project dependencies +# 2. Install project dependencies npm install -# 3. 运行应用（开发模式）| Run the application (development mode) +# 3. Run the application (development mode) npm run dev ``` -## 致谢 | Acknowledgments +## 致谢 -- [密语 CipherTalk](https://github.com/ILoveBingLu/miyu) 为本项目提供了基础框架 | provided the basic framework for this project -- [WeChat-Channels-Video-File-Decryption](https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption) 提供了视频解密相关的技术参考 | provided technical references for video decryption +- [密语 CipherTalk](https://github.com/ILoveBingLu/miyu) 为本项目提供了基础框架 +- [WeChat-Channels-Video-File-Decryption](https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption) 提供了视频解密相关的技术参考 -## 支持我们 | Support Us +--- + +**Acknowledgments** + +- [CipherTalk](https://github.com/ILoveBingLu/miyu) provided the basic framework for this project +- [WeChat-Channels-Video-File-Decryption](https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption) provided technical references for video decryption + +## 支持我们 如果 WeFlow 确实帮到了你，可以考虑请我们喝杯咖啡： +> TRC20 **Address:** `TZCtAw8CaeARWZBfvjidCnTcfnAtf6nvS6` + +--- + +**Support Us** + If WeFlow has truly helped you, consider buying us a coffee: > TRC20 **Address:** `TZCtAw8CaeARWZBfvjidCnTcfnAtf6nvS6`