mirror of
https://github.com/vee1e/mitmproxy.git
synced 2026-09-01 18:27:18 +00:00
mirror of https://github.com/vee1e/mitmproxy - An interactive TLS-capable intercepting HTTP proxy for penet
35bcadd5e1
* docs: Add --cask in brew install command # Motivation As a Brewfile user, the current installation command in the documentation does not tell me that mitmproxy is a Cask, which is a bit of an inconvenience due to how Brewfile works. Adding a formulae in a Brewfile is done by adding the line `brew "<formulae>"` while adding a cask in a Brewfile is done by adding the line `cask "<cask>"` Contrarily to the behavior of the brew install command, adding a formulae line in the Brewfile will not check for a Cask if the formulae does not exist: it will just fail. # Impact The brew install command currently works by first checking if a "mitmproxy" formulae exists in the homebrew repository, then after finding out there is none, it checks for a "mitmproxy" cask in the homebrew repository. Adding the explicit `--cask` argument allows to skip the unnecessary formulae existence check, while being more convenient for Brewfile users. # TL;DR Adding the explicit `--cask` argument is useful to Brewfile users in such that they directly know that mitmproxy is a Cask, while not impacting users copy-pasting the command directly in their terminal (while also avoiding an unwanted check for a corresponding formulae before the cask installation). * [autofix.ci] apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> |
||
|---|---|---|
| .github | ||
| docs | ||
| examples | ||
| mitmproxy | ||
| release | ||
| test | ||
| web | ||
| .gitattributes | ||
| .gitignore | ||
| CHANGELOG.md | ||
| codecov.yml | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| MANIFEST.in | ||
| pyproject.toml | ||
| README.md | ||
| SECURITY.md | ||
mitmproxy
mitmproxy is an interactive, SSL/TLS-capable intercepting proxy with a console
interface for HTTP/1, HTTP/2, and WebSockets.
mitmdump is the command-line version of mitmproxy. Think tcpdump for HTTP.
mitmweb is a web-based interface for mitmproxy.
Installation
The installation instructions are here. If you want to install from source, see CONTRIBUTING.md.
Documentation & Help
General information, tutorials, and precompiled binaries can be found on the mitmproxy website.
The documentation for mitmproxy is available on our website:
If you have questions on how to use mitmproxy, please use GitHub Discussions!
Contributing
As an open source project, mitmproxy welcomes contributions of all forms.