srdusr
aboutsummaryrefslogtreecommitdiffstats
path: root/internal
diff options
context:
space:
mode:
authorsrdusr <[email protected]>2026-02-18 21:55:00 +0200
committersrdusr <[email protected]>2026-02-18 21:55:00 +0200
commit5200e412606c221fb618bd8e9a57a897553215d9 (patch)
treef3d118728f6986bad065cd82f290350cdcb6ab4a /internal
parentb8e5d5ea37cc64ffa05352c3fb3130ca59471935 (diff)
downloadmitmux-5200e412606c221fb618bd8e9a57a897553215d9.tar.gz
mitmux-5200e412606c221fb618bd8e9a57a897553215d9.zip
Add README
the third explicit ask, alongside the Burp/ZAP/Caido gap pass and vi bindings: user-facing documentation. Covers what mitmux is and why it's two binaries (daemon owns the proxy and history, TUI is a thin client - restarting or crashing the UI never interrupts capture), install/build, a quick-start walkthrough (start daemon, trust the CA, point a client at it, open the TUI), per-feature usage (History, Repeater, Intruder, match-and-replace), the full search syntax (free text, host:/status:/source:/flagged: filters, AND/OR/NOT), the vi-modal command set for the Repeater/Intruder editors, an architecture section (daemon/TUI split, the raw-bytes-as-source-of-truth capture model and exact-vs-reconstructed distinction), package layout, dev commands, and an honest known-limitations list matching the scope decisions already tracked in PLAN.md rather than overselling anything. Verified rather than just written: built both binaries with the exact commands in the Install section, ran mitmuxd with no flags to confirm the documented defaults (127.0.0.1:8080, ~/.config/mitmux) are actually what ships, ran the exact curl command from Quick start against a real site through the proxy, and opened the TUI to confirm the captured request actually shows up - the full documented flow, end to end, not assumed correct because it reads correctly.
Diffstat (limited to 'internal')
0 files changed, 0 insertions, 0 deletions