How txthinking/brook works
Brook is a cross-platform programmable network tool for forwarding network traffic through proxy clients, servers, relays, and DNS services. Its user-facing workflow is to invoke a CLI mode, accept local proxy or service traffic, carry it over a selected transport, and forward it to a destination. The graph preserves major protocol and DNS branches visible in the tree; several services and plugin links are necessarily tentative because their CLI wiring or implementation was not excerpted.
Main entry points: main.go Brook CLI · client.go SOCKS client · brooklink.go Brook links · streamclient.go Stream framing
Components 20
CLI and links
- Brook CLI
cli/brook/main.go - Brook links
brooklink.go
Proxy endpoints
- SOCKS client
client.go - Brook server
server.go
Transport protocols
- QUIC client
quicclient.go - QUIC server
quicserver.go - WebSocket client
wsclient.go - WebSocket server
wsserver.go - Stream framing
streamclient.go - Packet framing
packetclient.go
DNS services
- DNS client
dnsclient.go - DNS server
dnsserver.go - DoH client
dohclient.go - DoH server
dohserver.go - DHCP server
dhcpserver.go
Forwarding and extensions
- Direct relay
relay.go - Brook relay
relayoverbrook.go - Network plugins
plugins
Other components
- Operator
- Network destination
Connections 28
- Operator → Brook CLI: invokes
README.md - Brook CLI → Brook links: parses links
cli/brook/main.go - Brook CLI → Brook relay: starts relay
cli/brook/main.go - Brook CLI → Brook server: starts service
- Brook CLI → SOCKS client: starts proxy
- Brook links → Stream framing: creates exchanger
brooklink.go - Brook links → Packet framing: creates exchanger
brooklink.go - SOCKS client → Stream framing: frames TCP
client.go - SOCKS client → Packet framing: frames UDP
client.go - SOCKS client → Network destination: forwards traffic
client.go - QUIC client → Stream framing: frames streams
quicclient.go - QUIC client → Network destination: tunnels traffic
quicclient.go - WebSocket client → Stream framing: frames streams
wsclient.go - WebSocket client → Network destination: tunnels traffic
wsclient.go - Brook server → Network destination: forwards traffic
server.go - QUIC server → Network destination: forwards traffic
quicserver.go - WebSocket server → Network destination: forwards traffic
wsserver.go - Direct relay → Network destination: relays traffic
relay.go - Brook relay → Brook links: creates exchanger
relayoverbrook.go - Brook relay → Network destination: relays traffic
relayoverbrook.go - DoH server → DNS client: queries DNS
dohserver.go - DoH server → DoH client: queries DoH
dohserver.go - DNS client → Network destination: resolves names
- DoH client → Network destination: queries upstream
- Brook CLI → DNS server: configures service
- Brook CLI → DoH server: configures service
- Brook CLI → DHCP server: configures service
- Brook CLI → Network plugins: registers plugins
cli/brook/main.go