diff options
author | Aldo Cortesi <aldo@nullcube.com> | 2016-02-18 09:19:05 +1300 |
---|---|---|
committer | Aldo Cortesi <aldo@nullcube.com> | 2016-02-18 09:27:08 +1300 |
commit | 92597f82ea8e4747ce1836ecd5eb2479486e8647 (patch) | |
tree | 2aa391b558d92c0122a16c155d3375d31221cde4 /docs/mitmdump.rst | |
parent | 49464de1cb159361c16a232b3d8c267b36e95483 (diff) | |
download | mitmproxy-92597f82ea8e4747ce1836ecd5eb2479486e8647.tar.gz mitmproxy-92597f82ea8e4747ce1836ecd5eb2479486e8647.tar.bz2 mitmproxy-92597f82ea8e4747ce1836ecd5eb2479486e8647.zip |
Docs and examples to top level
Diffstat (limited to 'docs/mitmdump.rst')
-rw-r--r-- | docs/mitmdump.rst | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/docs/mitmdump.rst b/docs/mitmdump.rst new file mode 100644 index 00000000..d9b4a26b --- /dev/null +++ b/docs/mitmdump.rst @@ -0,0 +1,66 @@ +.. _mitmdump: +.. program:: mitmdump + +mitmdump +======== + + +**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 :option:`--help` flag output for complete +documentation. + + + +Examples +-------- + +Saving traffic +^^^^^^^^^^^^^^ + +>>> mitmdump -w outfile + +Start up mitmdump in proxy mode, and write all traffic to **outfile**. + + +Filtering saved traffic +^^^^^^^^^^^^^^^^^^^^^^^ + +>>> mitmdump -nr infile -w outfile "~m post" + +Start mitmdump without binding to the proxy port (:option:`-n`), read all flows from +infile, apply the specified filter expression (only match POSTs), and write to +outfile. + + +Client replay +^^^^^^^^^^^^^ + +>>> mitmdump -nc outfile + +Start mitmdump without binding to the proxy port (:option:`-n`), then replay all +requests from outfile (:option:`-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 :ref:`clientreplay` section for more information. + + +Running a script +^^^^^^^^^^^^^^^^ + +>>> mitmdump -s examples/add_header.py + +This runs the **add_header.py** example script, which simply adds a new header +to all responses. + +Scripted data transformation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +>>> mitmdump -ns examples/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**. + |