Convert Figma logo to code with AI

avwo logowhistle

HTTP, HTTP2, HTTPS, Websocket debugging proxy

14,748
1,114
14,748
56
View on GitHubView on NPM

Top Related Projects

mitmproxy's avatar

mitmproxy

37,624

An interactive TLS-capable intercepting HTTP proxy for penetration testers and software developers.

alibaba's avatar

anyproxy

7,888

A fully configurable http/https proxy in NodeJS

lightbody's avatar

browsermob-proxy

2,192

A free utility to help web developers watch and manipulate network traffic from their AJAX applications.

NetEase's avatar

pomelo

11,889

A fast,scalable,distributed game server framework for Node.js.

http-party's avatar

node-http-proxy

14,071

A full-featured http proxy for node.js

Quick Overview

Whistle is a cross-platform web debugging proxy tool based on Node.js. It provides a powerful set of features for capturing, inspecting, and modifying HTTP/HTTPS traffic between clients and servers, making it an invaluable tool for developers working on web applications and APIs.

Pros

  • Extensive feature set including traffic capture, modification, and simulation
  • User-friendly web interface for easy configuration and management
  • Supports both HTTP and HTTPS traffic interception
  • Highly extensible through plugins and custom rules

Cons

  • Steeper learning curve compared to some simpler proxy tools
  • Documentation can be challenging for non-Chinese speakers, as some parts are primarily in Chinese
  • May require additional setup for HTTPS interception on certain platforms

Getting Started

  1. Install Whistle globally using npm:

    npm install -g whistle

  2. Start Whistle:

    w2 start

  3. Configure your system or browser to use the Whistle proxy (default: 127.0.0.1:8899)

  4. Access the Whistle web interface at http://localhost:8899/

  5. Begin capturing and analyzing traffic by navigating to your target website or application

Competitor Comparisons

mitmproxy logo

mitmproxy

37,624

An interactive TLS-capable intercepting HTTP proxy for penetration testers and software developers.

Pros of mitmproxy

  • More powerful and flexible command-line interface
  • Better support for scripting and automation
  • Stronger focus on security testing and analysis

Cons of mitmproxy

  • Steeper learning curve for beginners
  • Less user-friendly GUI compared to Whistle
  • More complex setup process for certain scenarios

Code Comparison

mitmproxy:

def request(flow):
    if flow.request.host == "example.com":
        flow.request.headers["User-Agent"] = "Custom User Agent"

Whistle:

/example\.com/ reqHeaders://User-Agent/Custom User Agent/

Key Differences

  • mitmproxy is primarily a command-line tool with Python scripting capabilities, while Whistle offers a web-based interface and uses a rule-based system.
  • mitmproxy excels in advanced networking scenarios and security testing, whereas Whistle is more accessible for general web debugging and proxying tasks.
  • Whistle provides a more intuitive visual interface for managing rules and inspecting traffic, making it easier for non-technical users to get started.

Both tools are powerful in their own right, with mitmproxy offering more advanced features and flexibility, while Whistle provides a more user-friendly experience for common web debugging tasks.

alibaba logo

anyproxy

7,888

A fully configurable http/https proxy in NodeJS

Pros of AnyProxy

  • Simpler setup and configuration process
  • Better documentation and examples for beginners
  • More lightweight and focused on core proxy functionality

Cons of AnyProxy

  • Less feature-rich compared to Whistle
  • Limited built-in UI for rule management and debugging
  • Fewer advanced features for complex scenarios

Code Comparison

AnyProxy:

module.exports = {
  summary: 'a rule to hack response',
  *beforeSendResponse(requestDetail, responseDetail) {
    if (requestDetail.url.indexOf('example.com') > -1) {
      const newResponse = responseDetail.response;
      newResponse.body += '-- modified by anyproxy --';
      return { response: newResponse };
    }
  },
};

Whistle:

exports.handleResponseRules = async (ctx) => {
  const { fullUrl, headers, body } = ctx.response;
  if (fullUrl.indexOf('example.com') > -1) {
    ctx.body = body + '-- modified by whistle --';
  }
};

Both projects offer proxy functionality with rule-based modifications. AnyProxy provides a more straightforward approach, while Whistle offers more advanced features and a built-in UI for rule management. AnyProxy might be better suited for simpler use cases, whereas Whistle excels in complex scenarios with its extensive plugin system and debugging tools.

lightbody logo

browsermob-proxy

2,192

A free utility to help web developers watch and manipulate network traffic from their AJAX applications.

Pros of BrowserMob Proxy

  • Java-based, integrates well with Selenium WebDriver for automated testing
  • Supports HAR (HTTP Archive) file generation for detailed network analysis
  • More mature project with longer development history

Cons of BrowserMob Proxy

  • Less active development and maintenance compared to Whistle
  • Limited built-in features for request/response manipulation
  • Steeper learning curve for non-Java developers

Code Comparison

BrowserMob Proxy (Java):

Proxy proxy = new BrowserMobProxyServer();
proxy.start(0);
Selenium driver = new ChromeDriver(proxy.seleniumProxy());
proxy.newHar("test");
driver.get("http://example.com");
Har har = proxy.getHar();

Whistle (JavaScript):

const whistle = require('whistle');
const w2 = new whistle();
w2.start({
  port: 8899,
  rules: 'example.com forward://127.0.0.1:8080'
});

Both projects serve as HTTP proxies for debugging and testing, but they cater to different ecosystems. BrowserMob Proxy is more focused on Java-based testing environments, while Whistle offers a more flexible, JavaScript-based approach with a wider range of built-in features for request/response manipulation. Whistle has a more active development community and frequent updates, making it potentially more suitable for modern web development workflows.

NetEase logo

pomelo

11,889

A fast,scalable,distributed game server framework for Node.js.

Pros of Pomelo

  • Designed specifically for game server development, offering scalable and real-time multiplayer game infrastructure
  • Supports multiple programming languages (JavaScript, TypeScript, C#) for game logic implementation
  • Provides built-in components for common game server features like channel management and session handling

Cons of Pomelo

  • Steeper learning curve due to its focus on game server architecture
  • Less versatile for general-purpose web development compared to Whistle
  • Requires more setup and configuration for non-game related projects

Code Comparison

Whistle (HTTP proxy configuration):

exports.handleRequest = async (ctx) => {
  if (ctx.fullUrl.includes('example.com')) {
    ctx.response.body = 'Intercepted';
  }
};

Pomelo (Game server route definition):

app.route('connector', function(session, msg, app) {
  var chatServers = app.getServersByType('chat');
  var res = dispatch(chatServers, session.get('rid'));
  return res.id;
});

Both projects serve different purposes, with Whistle focusing on HTTP debugging and Pomelo on game server development. Whistle offers a more straightforward approach for web developers, while Pomelo provides specialized tools for building scalable game backends.

http-party logo

node-http-proxy

14,071

A full-featured http proxy for node.js

Pros of node-http-proxy

  • Lightweight and focused solely on HTTP proxying
  • Easier to integrate into existing Node.js applications
  • More flexible for custom proxy implementations

Cons of node-http-proxy

  • Limited built-in features compared to Whistle
  • Requires more manual configuration for advanced use cases
  • Less comprehensive documentation and examples

Code Comparison

node-http-proxy:

const httpProxy = require('http-proxy');
const proxy = httpProxy.createProxyServer({});

proxy.on('proxyReq', function(proxyReq, req, res, options) {
  proxyReq.setHeader('X-Special-Proxy-Header', 'foobar');
});

Whistle:

exports.handleRequest = function(req, res) {
  req.headers['x-special-proxy-header'] = 'foobar';
  return true;
};

Summary

node-http-proxy is a lightweight and flexible HTTP proxy library for Node.js, ideal for developers who need to integrate proxying functionality into their existing applications. It offers more control over the proxying process but requires more manual configuration.

Whistle, on the other hand, is a more comprehensive proxy tool with a wider range of built-in features and a user-friendly interface. It's better suited for debugging and testing scenarios, offering a more complete out-of-the-box solution.

The choice between the two depends on the specific requirements of your project and the level of control you need over the proxying process.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

whistle logo

Whistle

NPM version node version Test coverage npm download NPM count License

中文 · English

Whistle 是一个基于 Node.js 开发的功能强大、操作简单的跨平台抓包调试工具。它支持多种代理模式（如 HTTP、HTTPS、Socks、反向代理等），可用于抓包分析或通过配置规则修改 HTTP、HTTPS、HTTP/2、WebSocket、TCP 请求。Whistle 还内置了 Weinre、Log、Composer 等工具，支持查看远程页面的 DOM 结构、调试 console 输出、重放或编辑请求等。此外，Whistle 支持插件扩展，也可作为 NPM 包被其他项目引用。

安装

Windows PC 或 Mac PC 推荐使用客户端：https://github.com/avwo/whistle-client。

如果采用 Whistle 客户端可以跳过该安装步骤

Linux PC、服务器等其它系统可以用命令行版本，需严格按如下 4 个步骤安装：

  1. 安装 Whistle
  2. 启动 Whistle
  3. 安装根证书
  4. 设置代理

安装 Whistle

根据实际情况选择以下一种安装方式即可：

  1. 通过 npm 安装（需要先安装 Node.JS：https://nodejs.org/ ）：

    npm i -g whistle

  2. 通过 brew 安装（需要先安装 brew：https://brew.sh/ ）：

    brew install whistle

启动 Whistle

w2 start

Whistle 默认启动 HTTP 代理（IP：127.0.0.1，端口： 8899），可以通过 w2 start -p 8888 修改端口，如果已启动需要通过 w2 restart -p 8888 重启修改端口

完整命令行功能参见完整文档：https://wproxy.org/whistle/options.html

安装根证书

启动 Whistle 后可以通过下面的命令安装根证书：

w2 ca --enable-https
Windows 需要最后点击 “是(Y)” 确认 点击 是(Y)
Mac 需要输入开机密码或指纹验证 输入开机密码 输入指纹

手机等其它端如何安装根证书参见完整文档：https://wproxy.org/whistle/webui/https.html

设置代理

Windows PC 或 Mac PC 有以下四种方式，根据实际情况选择其中一种即可：

  1. 【推荐】 通过安装 Chrome 插件 SwitchyOmega 设置代理：https://chromewebstore.google.com/detail/proxy-switchyomega/padekgcemlokbadohgkifijomclgjgif

    Chrome 应用商店需要翻墙，如果无法访问请手动安装：https://proxy-switchyomega.com/download/

    SwitchyOmega 设置方法示例图 imageimage

  2. 通过命令行设置系统代理：

    w2 proxy

    也可以指定IP（默认127.0.0.1）和端口： w2 proxy "10.x.x.x:8888" ，关闭系统设置代理用 w2 proxy 0

  3. 直接在客户端上设置代理，如 FireFox、微信开发者工具等内置了设置代理功能

    FireFox 设置代理示例图 image

  4. 通过 Proxifier 设置代理（针对无法设置代理且不使用系统代理的客户端）：https://www.proxifier.com/docs/win-v4/http-proxy.html

Linux 设置路径: Settings > Network > VPN > Network Proxy > Manual

Linux 设置代理示例图 image

手机等移动端设备需要在 设置 中配置当前 Wi-Fi 的代理，以 iOS 为例：

iOS 设置代理示例图 image

使用

按上面步骤安装好 Whistle，在 Chrome 浏览器上打开链接 http://local.whistlejs.com ，即可看到如下操作界面：

network rules

其中，Network 为查看抓包界面，Rules 为配置规则，Values 为配置数据界面（配合 Rules 使用），Plugins 为已安装的插件列表。

界面功能

重放请求 image
编辑或构造请求 image

其它界面功能参见完整文档：https://wproxy.org/whistle/webui/

规则功能

Whistle 规则可看成是如下系统 hosts 规则的扩展：

# 一个域名对应一个 IP
127.0.0.1 localhost
::1 localhost
# 多个域名对应一个 IP
10.2.55.3 www.test.com www.example.com

系统 hosts 规则的功能单一，只支持修改 DNS及匹配域名，且有 DNS 缓存问题，无法满足日常工作需求，Whistle 规则扩展了系统 hosts 规则的功能，匹配方式上不仅支持域名匹配、路径匹配、通配符匹配、正则匹配等，还支持通过请求方法，响应状态码、请求（响应）头、请求内容等进一步过滤；功能上不仅支持修改 DNS，还支持修改端口，CNAME，设置代理，修改请求 URL、请求方法、响应状态码、请求头、响应头、请求内容、响应内容等，理论上可以修改 HTTP 请求的所有东西，Whistle 规则格式为：

  1. 默认格式

    pattern operation

  2. 支持匹配多个操作

    pattern operation1 operation2 ...

  3. 支持过滤器

    pattern operation1 operation2 ... includeFilter://filterPattern1 ... excludeFilter://filterPatternN ...

    多个 filter 之间是 或 的关系，即满足其中一个条件即可

  4. 支持位置调换（前提：operation 与 pattern 不同时为 URL 或域名）

    operation pattern [filters ...]
operation pattern1 pattern2 ... [filters ...]

  5. 支持换行

    line`
operation
pattern1
pattern2 ...
[filters ...]
`

具体例子如下：

修改 DNS（设置 Hosts）

  1. 域名匹配

    www.test.com 127.0.0.1
# 支持带端口
www.test.com 127.0.0.1:8080
# CNAME 功能（端口可选）
www.test.com host://www.example.com:8181

    与系统 hosts 规则不同的是 Whistle 规则默认采用从左到右的映射方式，**从上到下的优先级**，但在 operation 与 pattern 不同时为 URL 或域名情况下可调换位置，所以也兼容系统 hosts 规则，即：127.0.0.1:8080 www.test.com

  2. 路径匹配

    www.test.com/path/to 127.0.0.1:8080
# 支持带协议
https://www.test.com/path/to 127.0.0.1:8080

  3. 通配符匹配

    # 域名通配符，匹配 test.com 的所有子代域名
**.test.com 127.0.0.1:8080
# 支持带协议域名通配符
https://**.test.com 127.0.0.1:8080
# 路径通配符（* 是路径的合法字符，所以前面要加 ^ 告诉 Whistle 是通配符）
^**.test.com/*/path/to 127.0.0.1:8080
# 支持带协议路径通配符
^https://**.test.com/*/path/to 127.0.0.1:8080

    *、**、*** 匹配的范围不同，详情参见完整文档：https://wproxy.org/whistle/pattern.html

  4. 正则匹配

    # 内部的 `/` 可以不转义，等价于 `new RegExp('^https?://\w+\.test\.com')`
/^https?://\w+\.test\.com/ 127.0.0.1:8080

  5. 过滤匹配

    # `pattern` 同上面的域名、路径、正则，表示除了匹配 `pattern` 还要满足请求头 `cookie` 包含 `env=test`
pattern 127.0.0.1:8080 includeFilter://reqH.cookie=/env=test/
修改表单数据
# 修改表单里面的 `test` 字段的值
pattern reqMerge://test=123

# 删除表单里面的 `abc` 字段
pattern delete://reqBody.abc
设置跨域响应头
# 以路径匹配为例，设置跨域响应头 Access-Control-Allow-Origin: *，且排除 OPTION 请求
pattern resCors://* excludeFilter://m:option

所有规则参见完整文档：https://wproxy.org/whistle/rules/

安装插件

插件需通过命令行安装：

w2 i whistle.inspect whistle.vase

上述插功能介绍及源码：https://github.com/whistle-plugins，客户端可通过界面安装 ：https://github.com/avwo/whistle-client

安装后即可在管理界面的 Plugins 看到这两个插件：

插件列表示例图 image

每个插件默认可以新增两个规则协议：

whistle.inspect://xxx
inspect://xxx

通过配置插件的自定义规则，可将匹配的请求转发到插件指定 hook 实现自定义功能，如果不需要也可通过插件的 package.json 的 whistleConfig 设置 "hideLongProtocol": true 或 "hideShortProtocol": true 隐藏对应规则协议

除了扩展规则，插件还支持扩展 Whistle 界面，以及提供操作界面、自带规则等功能，关于插件的安装、使用、开发参见完整文档：https://wproxy.org/whistle/plugins.html

License

MIT

NPM DownloadsLast 30 Days