mirror of
https://github.com/hicccc77/WeFlow.git
synced 2026-05-13 15:10:05 +00:00
Merge branch 'hicccc77:main' into refactor/ui-rebuild
This commit is contained in:
Jason
GitHub
107
README.md
107
README.md
@@ -2,6 +2,10 @@
|
||||
|
||||
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.
|
||||
|
||||
<p align="center">
|
||||
<img src="app.jpg" alt="WeFlow 应用预览" width="90%">
|
||||
</p>
|
||||
@@ -18,9 +22,13 @@ WeFlow 是一个**完全本地**的微信**实时**聊天记录查看、分析
|
||||
|
||||
> [!TIP]
|
||||
> 如果导出聊天记录后，想深入分析聊天内容可以试试 [ChatLab](https://chatlab.fun/)
|
||||
>
|
||||
> If you want to analyze your exported chat content in depth, try [ChatLab](https://chatlab.fun/)
|
||||
|
||||
> [!NOTE]
|
||||
> 仅支持微信 **4.0 及以上**版本，确保你的微信版本符合要求
|
||||
>
|
||||
> Only supports WeChat **version 4.0 and above**. Please ensure your WeChat version meets the requirements.
|
||||
|
||||
## 主要功能
|
||||
|
||||
@@ -32,6 +40,18 @@ WeFlow 是一个**完全本地**的微信**实时**聊天记录查看、分析
|
||||
- HTTP API 接口（供开发者集成）
|
||||
- 查看完整能力清单：[详细功能](#详细功能清单)
|
||||
|
||||
---
|
||||
|
||||
**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](#详细功能清单)
|
||||
|
||||
## 支持平台与设备
|
||||
|
||||
| 平台 | 设备/架构 | 安装包 |
|
||||
@@ -40,12 +60,30 @@ WeFlow 是一个**完全本地**的微信**实时**聊天记录查看、分析
|
||||
| macOS | Apple Silicon（M 系列，arm64） | `.dmg` |
|
||||
| Linux | x64 设备（amd64） | `.AppImage`、`.tar.gz` |
|
||||
|
||||
---
|
||||
|
||||
**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 users can quickly install with `yay -S weflow`
|
||||
|
||||
## 详细功能清单
|
||||
|
||||
当前版本已支持以下能力：
|
||||
@@ -64,6 +102,26 @@ WeFlow 是一个**完全本地**的微信**实时**聊天记录查看、分析
|
||||
| **联系人** | 导出微信好友、群聊、公众号信息；尝试找回曾经的好友（功能尚不完善） |
|
||||
| **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** | 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]
|
||||
@@ -78,6 +136,20 @@ WeFlow 提供本地 HTTP API 服务，支持通过接口查询消息数据，可
|
||||
|
||||
完整接口文档：[点击查看](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 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)
|
||||
|
||||
## 面向开发者
|
||||
|
||||
如果你想从源码构建或为项目贡献代码，请遵循以下步骤：
|
||||
@@ -94,17 +166,50 @@ npm install
|
||||
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
|
||||
git clone https://github.com/hicccc77/WeFlow.git
|
||||
cd WeFlow
|
||||
|
||||
# 2. Install project dependencies
|
||||
npm install
|
||||
|
||||
# 3. Run the application (development mode)
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## 致谢
|
||||
|
||||
- [密语 CipherTalk](https://github.com/ILoveBingLu/miyu) 为本项目提供了基础框架
|
||||
- [WeChat-Channels-Video-File-Decryption](https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption) 提供了视频解密相关的技术参考
|
||||
|
||||
---
|
||||
|
||||
**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`
|
||||
|
||||
## Star History
|
||||
|
||||
<a href="https://www.star-history.com/#hicccc77/WeFlow&type=date&legend=top-left">
|
||||
@@ -121,4 +226,6 @@ npm run dev
|
||||
|
||||
**请负责任地使用本工具，遵守相关法律法规**
|
||||
|
||||
**Please use this tool responsibly and comply with relevant laws and regulations**
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user