brook README

The project's README from github.com/txthinking/brook. As one markdown file: README.md.

Brook

A cross-platform programmable network tool.

Sponsor: Shiliew - Focuses on providing stable network services

Server

bash <(curl https://bash.ooo/nami.sh)
nami install brook
brook server -l :9999 -p hello

Client

You may want to use brook link to customize some parameters

Docs

https://www.txthinking.com/brook.html

https://brook.app

brook (txthinking/brook)

Searching Database…

15.2K ·GitHub
What is this?Brook is a cross-platform programmable network tool that works as both a server and a client, giving you SOCKS5 proxying, TLS encryption, traffic decryption/MITM inspection, and packet capture in one toolkit.
Is this a plain VPN app or something I can customize myself?It is more than a toggle-switch VPN: Brook includes a scripting layer called Brook Script, with a public gallery of example scripts, so you can program how traffic is handled instead of relying on fixed behavior.
How do I get a server and client running?You run the Brook binary as a Server on one machine, then install a matching Client build for your platform (iOS, Android, macOS, Windows, Linux, or OpenWrt) and point it at the server; the README includes a dedicated Linux install walkthrough.
Does the macOS client behave the same as the others?No, macOS gets separate documentation for an 'App Mode', implying its traffic-routing setup differs from the plain CLI/service mode used on other platforms.
Which platforms can run the client?Clients are provided for iOS, Android, macOS, Windows, Linux, and OpenWrt routers.
What is Brook Script?It is Brook's built-in scripting system for writing custom rules on how network traffic is handled, backed by a public 'Brook Script Gallery' of ready-made examples.
What does the brook link command do?It packages a server's connection parameters into a single shareable link so a client can be configured in one step instead of entering each setting by hand.
Can Brook intercept and decrypt traffic, not just tunnel it?Yes — the project is built around MITM, decryption, and packet-capture capabilities alongside proxying, so it can inspect and analyze traffic as part of its programmable toolkit.
Creator
txthinking
Size
37.3 MB
Stars
15.2K
Age
9y
Commits · 90 Days