Skip to content

sjzar/chatlog

Repository files navigation

Chatlog

chatlog

聊天记录工具,帮助大家轻松使用自己的聊天数据

Go Report Card GoDoc GitHub release GitHub license

chatlog

Feature

  • 从本地数据库文件获取聊天数据
  • 支持 Windows / macOS 系统
  • 支持微信 3.x / 4.0 版本
  • 提供 Terminal UI 界面 & 命令行工具
  • 提供 HTTP API 服务,支持查询聊天记录、联系人、群聊、最近会话等信息
  • 支持 MCP SSE 协议,可与支持 MCP 的 AI 助手无缝集成
  • 支持多媒体消息,支持解密图片、语音
  • 支持自动解密数据,简化使用流程
  • 支持多账号管理,可在不同账号间切换

TODO

  • 聊天数据全文索引
  • 聊天数据统计 & Dashboard

Quick Start

基本步骤

  1. 安装 Chatlog下载预编译版本使用 Go 安装
  2. 运行程序:执行 chatlog 启动 Terminal UI 界面
  3. 解密数据:选择 解密数据 菜单项
  4. 开启 HTTP 服务:选择 开启 HTTP 服务 菜单项
  5. 访问数据:通过 HTTP APIMCP 集成 访问聊天记录

💡 提示:如果电脑端微信聊天记录不全,可以从手机端迁移数据

常见问题快速解决

安装指南

从源码安装

go install github.com/sjzar/chatlog@latest

下载预编译版本

访问 Releases 页面下载适合您系统的预编译版本。

使用指南

Terminal UI 模式

最简单的使用方式是通过 Terminal UI 界面操作:

chatlog

操作方法:

  • 使用 键选择菜单项
  • Enter 确认选择
  • Esc 返回上级菜单
  • Ctrl+C 退出程序

命令行模式

对于熟悉命令行的用户,可以直接使用以下命令:

# 获取微信数据密钥
chatlog key

# 解密数据库文件
chatlog decrypt

# 启动 HTTP 服务
chatlog server

从手机迁移聊天记录

如果电脑端微信聊天记录不全,可以从手机端迁移数据:

  1. 打开手机微信,进入 我 - 设置 - 通用 - 聊天记录迁移与备份
  2. 选择 迁移 - 迁移到电脑,按照提示操作
  3. 完成迁移后,重新运行 chatlog 获取密钥并解密数据

此操作不会影响手机上的聊天记录,只是将数据复制到电脑端

平台特定说明

Windows 版本说明

如遇到界面显示异常(如花屏、乱码等),请使用 Windows Terminal 运行程序

macOS 版本说明

macOS 用户在获取密钥前需要临时关闭 SIP(系统完整性保护):

  1. 关闭 SIP

    # 进入恢复模式
    # Intel Mac: 重启时按住 Command + R
    # Apple Silicon: 重启时长按电源键
    
    # 在恢复模式中打开终端并执行
    csrutil disable
    
    # 重启系统
  2. 安装必要工具

    # 安装 Xcode Command Line Tools
    xcode-select --install
  3. 获取密钥后:可以重新启用 SIP(csrutil enable),不影响后续使用

Apple Silicon 用户注意:确保微信、chatlog 和终端都不在 Rosetta 模式下运行

HTTP API

启动 HTTP 服务后(默认地址 http://127.0.0.1:5030),可通过以下 API 访问数据:

聊天记录查询

GET /api/v1/chatlog?time=2023-01-01&talker=wxid_xxx

参数说明:

  • time: 时间范围,格式为 YYYY-MM-DDYYYY-MM-DD~YYYY-MM-DD
  • talker: 聊天对象标识(支持 wxid、群聊 ID、备注名、昵称等)
  • limit: 返回记录数量
  • offset: 分页偏移量
  • format: 输出格式,支持 jsoncsv 或纯文本

其他 API 接口

  • 联系人列表GET /api/v1/contact
  • 群聊列表GET /api/v1/chatroom
  • 会话列表GET /api/v1/session

多媒体内容

聊天记录中的多媒体内容会通过 HTTP 服务进行提供,可通过以下路径访问:

  • 图片内容GET /image/<id>
  • 视频内容GET /video/<id>
  • 文件内容GET /file/<id>
  • 语音内容GET /voice/<id>
  • 多媒体内容GET /data/<data dir relative path>

当请求图片、视频、文件内容时,将返回 302 跳转到多媒体内容 URL。
当请求语音内容时,将直接返回语音内容,并对原始 SILK 语音做了实时转码 MP3 处理。
多媒体内容 URL 地址为基于数据目录的相对地址,请求多媒体内容将直接返回对应文件,并针对加密图片做了实时解密处理。

MCP 集成

Chatlog 支持 MCP (Model Context Protocol) SSE 协议,可与支持 MCP 的 AI 助手无缝集成。
启动 HTTP 服务后,通过 SSE Endpoint 访问服务:

GET /sse

快速集成

Chatlog 可以与多种支持 MCP 的 AI 助手集成,包括:

  • ChatWise: 直接支持 SSE,在工具设置中添加 http://127.0.0.1:5030/sse
  • Cherry Studio: 直接支持 SSE,在 MCP 服务器设置中添加 http://127.0.0.1:5030/sse

对于不直接支持 SSE 的客户端,可以使用 mcp-proxy 工具转发请求:

  • Claude Desktop: 通过 mcp-proxy 支持,需要配置 claude_desktop_config.json
  • Monica Code: 通过 mcp-proxy 支持,需要配置 VSCode 插件设置

详细集成指南

查看 MCP 集成指南 获取各平台的详细配置步骤和注意事项。

Prompt 示例

为了帮助大家更好地利用 Chatlog 与 AI 助手,我们整理了一些 prompt 示例。希望这些 prompt 可以启发大家更有效地查询和分析聊天记录,获取更精准的信息。

查看 Prompt 指南 获取详细示例。

同时欢迎大家分享使用经验和 prompt!如果您有好的 prompt 示例或使用技巧,请通过 Discussions 进行分享,共同进步。

免责声明

⚠️ 重要提示:使用本项目前,请务必阅读并理解完整的 免责声明

本项目仅供学习、研究和个人合法使用,禁止用于任何非法目的或未授权访问他人数据。下载、安装或使用本工具即表示您同意遵守免责声明中的所有条款,并自行承担使用过程中的全部风险和法律责任。

摘要(请阅读完整免责声明)

  • 仅限处理您自己合法拥有的聊天数据或已获授权的数据
  • 严禁用于未经授权获取、查看或分析他人聊天记录
  • 开发者不对使用本工具可能导致的任何损失承担责任
  • 使用第三方 LLM 服务时,您应遵守这些服务的使用条款和隐私政策

本项目完全免费开源,任何以本项目名义收费的行为均与本项目无关。

License

本项目基于 Apache-2.0 许可证 开源。

隐私政策

本项目不收集任何用户数据。所有数据处理均在用户本地设备上进行。使用第三方服务时,请参阅相应服务的隐私政策。

Thanks