docs/src/content/_index.md
mitmproxy is a set of tools that provide an interactive, SSL/TLS-capable intercepting proxy for HTTP/1, HTTP/2, and WebSockets.
The mitmproxy project's tools are a set of front-ends that expose common underlying functionality. When we talk about "mitmproxy" we usually refer to any of the three tools - they are just different front-ends to the same core proxy.
mitmproxy is an interactive, SSL/TLS-capable intercepting proxy with a console interface for HTTP/1, HTTP/2, and WebSockets.
mitmweb is a web-based interface for mitmproxy.
mitmdump is the command-line version of mitmproxy. Think tcpdump for HTTP.
Distribution packages can be found on the mitmproxy website. Development information and our source code can be found in our GitHub repository.
{{< figure src="/screenshots/mitmproxy.png" alt="screenshot of the terminal ui" >}}
mitmproxy is a console tool that allows interactive examination and
modification of HTTP traffic. It differs from mitmdump in that all flows are
kept in memory, which means that it's intended for taking and manipulating
small-ish samples. Use the ? shortcut key to view, context-sensitive
documentation from any mitmproxy screen.
{{< figure src="/screenshots/mitmweb.png" alt="screenshot of the web ui" >}}
mitmweb is mitmproxy's web-based user interface that allows interactive examination and modification of HTTP traffic. Like mitmproxy, it differs from mitmdump in that all flows are kept in memory, which means that it's intended for taking and manipulating small-ish samples.
{{% note %}} Mitmweb is currently in beta. We consider it stable for all features currently exposed in the UI, but it still misses a lot of mitmproxy's features. {{% /note %}}
mitmdump is the command-line companion to mitmproxy. It provides
tcpdump-like functionality to let you view, record, and programmatically
transform HTTP traffic. See the --help flag output for complete
documentation.
mitmdump -w outfile
Start up mitmdump in proxy mode, and write all traffic to outfile.
mitmdump -nr infile -w outfile "~m post"
Start mitmdump without binding to the proxy port (-n), read all flows
from infile, apply the specified filter expression (only match POSTs),
and write to outfile.
mitmdump -nC outfile
Start mitmdump without binding to the proxy port (-n), then replay all
requests from outfile (-C filename). Flags combine in the obvious way,
so you can replay requests from one file, and write the resulting flows
to another:
mitmdump -nC srcfile -w dstfile
See the [client-side replay]({{< relref "/overview/features#client-side-replay"
}}) section for more information.
mitmdump -s examples/simple/add_header.py
This runs the add_header.py example script, which simply adds a new header to all responses.
mitmdump -ns examples/simple/add_header.py -r srcfile -w dstfile
This command loads flows from srcfile, transforms it according to the specified script, then writes it back to dstfile.