Installing wiretap

Get up and running in seconds.

Using homebrew

The easiest way to install wiretap is to use homebrew if you’re on OSX or Linux.

We have our own tap available that gives the latest and greatest version.

brew install pb33f/taps/wiretap

Using npm or yarn

Building a JavaScript / TypeScript application? No problem, grab your copy of wiretap using your preference of yarn or npm.

yarn global add @pb33f/wiretap npm install -g @pb33f/wiretap

Using cURL

Do you want to use wiretap in a linux only or CI/CD pipeline or workflow? Or you don’t want to/can’t use a package manager like brew?

No problem. Use cURL to download and run our installer script.

curl -fsSL | sh

Using Docker

Love containers? Don’t want to install anything? No problem, use our Docker image.

docker pull pb33f/wiretap

Next, run docker using the -rm (remove the container after running) and -v flags (mount local volume).

docker run -p 9090:9090 -p 9091:9091 -p 9092:9092 --rm -v $PWD:/work:rw \ pb33f/wiretap -u

We enable the following default ports 9090, 9091, and 9092 for the daemon, monitor, and websockets used by ranch respectively.

Installing on Windows

We haven’t yet integrated with a Windows package manager, however we still build Windows binaries.

To grab your copy of wiretap for Windows, you can pull it from the latest releases on github and download the Windows version for your CPU type.

Build from scratch

Want to tinker with the tool? Prefer your own compilations? Trust issues? No problem.

wiretap is built using golang, golang 1.18+ must be installed.

git clone

You have two choices for building, the first is to use Make (if you’re on OSX or linux), or you can just build using go build

Using Make

Old school? Like the old ways? Yeah, us too. So let’s relive the glory days! This step will build both the wiretap daemon and the monitor UI.


Once built, the binary will be located in bin/ and named wiretap

Build the monitor UI

To build just the monitor UI:

make build-ui

Build the daemon

To build just the daemon:

make build-daemon

Building using go

Basically the same thing that Make does for you, except you get the pleasure of typing it out.

go build wiretap.go