mirror of
https://github.com/hicccc77/WeFlow.git
synced 2026-03-20 06:14:33 +08:00
118 lines
3.5 KiB
Markdown
118 lines
3.5 KiB
Markdown
# WeFlow
|
||
|
||
WeFlow 是一个**完全本地**的微信**实时**聊天记录查看、分析与导出工具。它可以实时获取你的微信聊天记录并将其导出，还可以根据你的聊天记录为你生成独一无二的分析报告
|
||
|
||
---
|
||
|
||
<p align="center">
|
||
<img src="app.png" alt="WeFlow" width="90%">
|
||
</p>
|
||
|
||
---
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/hicccc77/WeFlow/stargazers">
|
||
<img src="https://img.shields.io/github/stars/hicccc77/WeFlow?style=flat-square" alt="Stargazers">
|
||
</a>
|
||
<a href="https://github.com/hicccc77/WeFlow/network/members">
|
||
<img src="https://img.shields.io/github/forks/hicccc77/WeFlow?style=flat-square" alt="Forks">
|
||
</a>
|
||
<a href="https://github.com/hicccc77/WeFlow/issues">
|
||
<img src="https://img.shields.io/github/issues/hicccc77/WeFlow?style=flat-square" alt="Issues">
|
||
<img src="https://gh-down-badges.linkof.link/hicccc77/WeFlow/" alt="Downloads" />
|
||
</a>
|
||
<a href="https://t.me/weflow_cc">
|
||
<img src="https://img.shields.io/badge/Telegram%20频道-0088cc?style=flat-square&logo=telegram&logoColor=0088cc&labelColor=white" alt="Telegram">
|
||
</a>
|
||
</p>
|
||
|
||
|
||
> [!TIP]
|
||
> 如果导出聊天记录后，想深入分析聊天内容可以试试 [ChatLab](https://chatlab.fun/)
|
||
|
||
> [!NOTE]
|
||
> 仅支持微信 **4.0 及以上**版本，确保你的微信版本符合要求
|
||
|
||
## 主要功能
|
||
|
||
- 本地实时查看聊天记录
|
||
- 朋友圈图片、视频、**实况**的预览和解密
|
||
- 统计分析与群聊画像
|
||
- 年度报告与可视化概览
|
||
- 导出聊天记录为 HTML 等格式
|
||
- HTTP API 接口（供开发者集成）
|
||
|
||
|
||
## HTTP API
|
||
|
||
> [!WARNING]
|
||
> 此功能目前处于早期阶段，接口可能会有变动，请等待后续更新完善。
|
||
|
||
WeFlow 提供本地 HTTP API 服务，支持通过接口查询消息数据，可用于与其他工具集成或二次开发。
|
||
|
||
- **启用方式**：设置 → API 服务 → 启动服务
|
||
- **默认端口**：5031
|
||
- **访问地址**：`http://127.0.0.1:5031`
|
||
- **支持格式**：原始 JSON 或 [ChatLab](https://chatlab.fun/) 标准格式
|
||
|
||
📖 完整接口文档：[点击查看](docs/HTTP-API.md)
|
||
|
||
|
||
## 快速开始
|
||
|
||
若你只想使用成品版本，可前往 Release 下载并安装。
|
||
|
||
## 面向开发者
|
||
|
||
如果你想从源码构建或为项目贡献代码，请遵循以下步骤：
|
||
|
||
```bash
|
||
# 1. 克隆项目到本地
|
||
git clone https://github.com/hicccc77/WeFlow.git
|
||
cd WeFlow
|
||
|
||
# 2. 安装项目依赖
|
||
npm install
|
||
|
||
# 3. 运行应用（开发模式）
|
||
npm run dev
|
||
|
||
# 4. 打包可执行文件
|
||
npm run build
|
||
```
|
||
|
||
打包产物在 `release` 目录下。
|
||
|
||
|
||
|
||
## 致谢
|
||
|
||
- [密语 CipherTalk](https://github.com/ILoveBingLu/miyu) 为本项目提供了基础框架
|
||
- [WeChat-Channels-Video-File-Decryption](https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption) 提供了视频解密相关的技术参考
|
||
|
||
## 支持我们
|
||
|
||
如果 WeFlow 确实帮到了你，可以考虑请我们喝杯咖啡：
|
||
|
||
|
||
> TRC20 **Address:** `TZCtAw8CaeARWZBfvjidCnTcfnAtf6nvS6`
|
||
|
||
|
||
## Star History
|
||
|
||
<a href="https://www.star-history.com/#hicccc77/WeFlow&type=date&legend=top-left">
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=hicccc77/WeFlow&type=date&theme=dark&legend=top-left" />
|
||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=hicccc77/WeFlow&type=date&legend=top-left" />
|
||
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=hicccc77/WeFlow&type=date&legend=top-left" />
|
||
</picture>
|
||
</a>
|
||
|
||
<div align="center">
|
||
|
||
---
|
||
|
||
**请负责任地使用本工具，遵守相关法律法规**
|
||
|
||
</div>
|