Skip to content

Latest commit

 

History

History
210 lines (154 loc) · 6.04 KB

UserGuide.md

File metadata and controls

210 lines (154 loc) · 6.04 KB
Raw

用户指南

小白教程（大佬请看下面）

1. 安装

下载release中的exe文件(选择最新版)

2. 使用

  • 1.打开微信电脑版，登录微信
  • 2.进入下载的exe文件所在目录
  • 3.双击wx_dump.exe运行
  • 4.打开浏览器，访问 http://127.0.0.1:5000/ 使用图形界面
  • 5.根据提示操作

【注】更多详细使用方法关注公众号：逍遥之芯，回复：PyWxDump 获取图文教程。

详细教程(小白请看上面)

1. 安装

1.1 从pypi安装(安装稳定版)

pip install -U pywxdump

1.2 从源码安装(安装最新版)

pip install -U git+git://github.com/xaoyaoo/PyWxDump.git # 该方法无法安装网页图形界面

或

# 如果使用网页图形界面，需要执行以下命令
git clone https://github.com/xaoyaoo/wxdump_web.git
cd wxdump_web
npm run build
cd ..
# 安装PyWxDump
git clone https://github.com/xaoyaoo/PyWxDump.git
cp -r wxdump_web/dist PyWxDump/pywxdump/ui/web # 将网页图形界面文件复制到PyWxDump中，如果不需要网页图形界面，可以跳过这一步
cd PyWxDump
python -m pip install -U .

1.3 打包可执行文件exe

  • 默认你已经安装好python环境，并且下载了源码，进入项目根目录，同时已经安装了pyinstaller
  • 并且完成了1.2 从源码安装
cd tests
python build_exe.py
# 接着执行输出的打包脚本
pyinstaller --clean --distpath=dist dist/pywxdump.spec
  • 直接下载打包好的exe文件：release

2. 使用

2.1 命令行

激活虚拟环境后（如果有的话），在项目根目录下运行：

wxdump -h  # 查看具体帮助
# 用法: 
# wxdump 模式 [参数]
#  mode           运行模式:
#    bias         获取微信基址偏移
#    info         获取微信信息
#    wx_path      获取微信文件夹路径
#    decrypt      解密微信数据库
#    merge        [测试功能]合并微信数据库(MSG.db or MediaMSG.db)
#    all          【已废弃】获取微信信息，解密微信数据库，查看聊天记录
#    ui           启动网页图形界面
#    api          启动API服务, 默认端口5000,无图形界面

示例

点击展开示例

以下是示例命令：

获取微信基址偏移
wxdump bias -h # 查看具体帮助
wxdump bias --mobile <手机号> --name <微信昵称> --account <微信账号> [--key <密钥>] [--db_path <已登录账号的微信文件夹路径>] [--version_list_path <微信版本偏移文件路径>]
获取微信信息
wxdump info -h # 查看具体帮助
wxdump info [--version_list_path <微信版本偏移文件路径>]
获取微信文件夹路径
wxdump wx_path -h # 查看具体帮助
wxdump wx_path [-r <需要的数据库名称>] [-wf <WeChat Files 路径>] [-id <wxid_>]
解密微信数据库
wxdump decrypt -h # 查看具体帮助
wxdump decrypt -k <密钥> -i <数据库路径(目录or文件)> [-o <输出路径>]
获取微信信息、解密数据库、查看聊天记录，一条命令搞定，开放端口5000，浏览器访问查看聊天记录（支持局域网其他机器访问）
wxdump all -h # 【已废弃】查看具体帮助
wxdump all
启动网页图形界面（根据图形界面提示自行使用）
wxdump ui -h # 查看具体帮助
wxdump ui
启动API服务
wxdump api -h # 查看具体帮助
wxdump api

2.2 python API

import调用示例

点击展开示例 
# 单独使用各模块，返回值一般为字典，参数参考命令行
from pywxdump import *

# ************************************************************************************************ #
# 获取微信基址偏移
args = {
    "mode": "bias",
    "mobile": "13800138000",  # 手机号
    "name": "微信昵称",  # 微信昵称
    "account": "微信账号",  # 微信账号
    "key": "密钥",  # 密钥（可选）
    "db_path": "已登录账号的微信文件夹路径",  # 微信文件夹路径（可选）
    "version_list_path": "微信版本偏移文件路径"  # 微信版本偏移文件路径（可选）
}
bias_addr = BiasAddr(args["account"], args["mobile"], args["name"], args["key"], args["db_path"])
result = bias_addr.run(True, args["version_list_path"])
# ************************************************************************************************ #
# 获取微信信息
wx_info = read_info(VERSION_LIST, True)

# 获取微信文件夹路径
args = {
    "mode": "db_path",
    "require_list": "all",  # 需要的数据库名称（可选）
    "wx_files": "WeChat Files",  # 'WeChat Files'路径（可选）
    "wxid": "wxid_",  # wxid_，用于确认用户文件夹（可选）
}
user_dirs = get_wechat_db(args["require_list"], args["wx_files"], args["wxid"], True)
# ************************************************************************************************ #
# 解密微信数据库
args = {
    "mode": "decrypt",
    "key": "密钥",  # 密钥
    "db_path": "数据库路径(目录or文件)",  # 数据库路径
    "out_path": "/path/to/decrypted"  # 输出路径（必须是目录）[默认为当前路径下decrypted文件夹]
}
result = batch_decrypt(args["key"], args["db_path"], args["out_path"], True)
# ************************************************************************************************ #

更多使用方法参考tests文件夹下的test_*.py文件

2.3 可执行文件exe

进入exe文件所在目录，运行： wxdump.exe 模式 [参数]，方法同命令行

3. FAQ

详见FAQ

4. 更新日志

详见更新日志

5. 其他

进群密码请查看FAQ 关于系统支持版本：Windows 10 64位及以上、 python 3.8及以上，其他版本遇到错误需要自行解决