Skip to content

avwo/whistle-client

Repository files navigation

Whistle 客户端

中文 · English

Whistle 是一款功能强大的跨平台网络抓包调试工具,本客户端为官方桌面版本,支持以下操作系统:

  1. macOS
  2. Windows
  3. Linux (Fedora/Ubuntu)

安装

请根据你的操作系统选择对应的安装步骤。

macOS
1. 选择正确的安装包

根据你的 Mac 处理器类型选择对应版本:

2. 安装步骤
  1. 下载完成后,双击下载的 .dmg 文件

  2. 将 Whistle 图标拖拽至 Applications 文件夹

    install mac client
  3. 如遇以下情况:

    • 提示 "应用已存在" → 选择 "覆盖"
    • 无法覆盖 → 请先退出正在运行的 Whistle 客户端
3. 安全提示

某些企业安全软件可能误报,建议:

  • 首次运行时选择 "允许" 操作
  • 如有持续拦截,请联系IT部门将 Whistle 加入白名单
Windows
1. 下载安装包

根据你的权限需求选择适合的版本:

2. 运行安装程序

双击下载的安装包后,你可能会看到以下安全提示,请按顺序操作:

  1. 用户账户控制提示 → 点击 "是" 继续安装

    image
  2. 安装向导界面 → 按照提示逐步完成

Linux(Fedora/Ubuntu) 本客户端目前支持 Fedora 和 Ubuntu 两个 Linux 发行版。

下载安装包:

安装方法参考:https://zhuanlan.zhihu.com/p/517734580

用法

启动客户端

安装完成后,请通过以下方式启动:

  1. 点击桌面上的 Whistle 图标
  2. 或通过系统应用程序菜单找到 Whistle

启动后,请按以下步骤完成必要的初始设置(首次运行时必做):

  1. 打开客户端顶部 Whistle 菜单项
  2. 点击 Install Root CA:安装系统根证书,用于解析 HTTPS 请求
  3. 开启 Set As System Proxy:设置系统代理,用于捕获系统的 Web 请求

顶部菜单

Image
  1. Proxy Settings:见下方 Proxy Settings
  2. Install Root CA:安装根证书
  3. Check Update:查看是否有新版本
  4. Set As System Proxy:设置系统代理
  5. Start At Login:是否开机自动启动 Whistle 客户端
  6. Restart:重启客户端
  7. Quit:退出客户端

Proxy Settings

Proxy Settings
  1. Proxy Port:必填项,代理端口,默认为 8888
  2. Socks Port:新增 Socksv5 代理端口
  3. Bound Host:指定监听的网卡
  4. Proxy Auth:设置用户名和密码对经过代理的请求进行鉴权
  5. Bypass List:不代理的白名单域名,支持以下三种格式:
    • IP:127.0.0.1
    • 域名:www.test.com
    • 通配符:*.test.com(这包含 test.com 的所有子代域名)
  6. Use whistle's default storage directory:存储是否切回命令行版本的目录,这样可以保留之前的配置数据(勾选后要停掉命令行版本,否则配置可能相互覆盖)

安装插件

  1. 点击左侧导航栏的 Plugins 标签页
  2. 点击顶部的 Install 按钮
  3. 在弹出窗口中输入插件名称(支持同时安装多个插件):
    • 多个插件用空格或换行符分隔
    • 可指定自定义 npm 镜像源:
      • 直接在插件名后添加 --registry=镜像地址
      • 或从下拉列表选择历史使用过的镜像源
install plugins

示例(安装两个插件并使用国内镜像源):

w2 install --registry=https://registry.npmmirror.com whistle.script whistle.inspect

其他功能

Whistle 功能详见:https://github.com/avwo/whistle

常见问题

1. 启用客户端设置系统代理,部分应用(如 Outlook、Word 等)可能出现网络连接异常

查看抓包界面是否有如下的 captureError 异常请求:

captureError

将出现此类异常的域名配置到 Proxy SettingsBypass List 规则里面:

Bypass List

2. 如何更新客户端?

  • 检查新版本:点击左上角 Whistle 菜单 → Check Update → 按照提示完成更新
  • 手动下载更新:访问 GitHub Releases 下载最新版本,按上面的文档重新安装

3. 如何同步之前的数据?

Whistle 客户端默认使用独立的存储目录,如果要继续用命令行版本的目录,可以通过 Proxy SettingsUse whistle's default storage directory 切回命令行的默认目录:

image

注意:请确保同一时间只有一个 Whistle 实例访问该目录,多实例同时运行会造成配置冲突和数据覆盖!

License

MIT

About

HTTP, HTTP2, HTTPS, Websocket debugging proxy client

Resources

License

Stars

Watchers

Forks

Packages

No packages published