vee1e/mitmproxy
1
0
Fork 0
mirror of https://github.com/vee1e/mitmproxy.git synced 2026-09-01 18:27:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: console key binding docs and example

Browse source
This commit is contained in:
Aldo Cortesi 2018-05-15 10:34:55 +12:00
parent fe4c371001
commit 2db223decb
2 changed files with 29 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/src/content/tools-mitmproxy.md
View file

@ -16,3 +16,21 @@ 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.
### Key binding configuration
Mitmproxy's key bindings can be customized through in the
`~/.mitmproxy/keys.yaml` file. This file consists of a sequence of maps, with
the following keys:
* `key` (**mandatory**): The key to bind.
* `cmd` (**mandatory**): The command to execute when the key is pressed.
* `context`: A list of contexts in which the key should be bound. By default this is **global** (i.e. the key is bound everywhere). Valid contexts are `chooser`, `commands`, `dataviewer`, `eventlog`, `flowlist`, `flowview`, `global`, `grideditor`, `help`, `keybindings`, `options`.
* `help`: A help string for the binding which will be shown in the key binding browser.
#### Example
{{< example src="examples/keys.yaml" lang="yaml" >}}