Get started
Install Wiretap, verify the toolchain, run the demo scripts, then explore the mystery corpus.
Install
Official module:
github.com/theworker02/wiretap
on pkg.go.dev
(@v0.5.0).
go install
go install github.com/theworker02/wiretap/cmd/wiretap@v0.5.0
Build from source
git clone https://github.com/theworker02/wiretap.git
cd wiretap
make build && ./bin/wiretap version
# Windows: go build -o bin/wiretap.exe ./cmd/wiretap
# See docs/windows.md in the repo
Release binaries
Download OS/arch archives from GitHub Release v0.5.0 (built with GoReleaser).
Doctor
wiretap doctor
Checks Go version, project layout, samples, cache, and registered passes.
First analysis
wiretap analyze examples/mystery/captures.hex
wiretap analyze --format json -o reports/last.json examples/mystery/captures.hex
wiretap analyze --format html -o report.html examples/mystery/captures.hex
wiretap explain --at 0x02..0x03 examples/mystery/captures.hex
Demo scripts
From a full checkout of the repository:
# Unix / Git Bash / WSL
./scripts/demo.sh
# Windows PowerShell
.\scripts\demo.ps1
These scripts exercise analyze, explain, TUI hints, schema infer, codegen, visualize, eval, index, and authorized drop-folder capture.
Shell completion
source <(wiretap completion bash)
wiretap completion zsh
wiretap completion fish
wiretap completion powershell
Next
- CLI map
- Library usage
- Go module docs (pkg.go.dev)
- Example corpora
- Repo README and
docs/markdown (also viawiretap docs index)