mirror/kumomta
1
0
Fork 0
mirror of https://github.com/mailscope/kumomta.git synced 2026-09-07 02:58:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update list of command line tools

Browse Source
This commit is contained in:
Tom Mairs
2025-07-22 22:49:12 +00:00
parent 7903dff857
commit 7064344b04
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/userguide/operation/command-line-index.md
+7
View File
@@ -10,5 +10,12 @@ KumoMTA comes with several utilities that are useful for debugging or supporting
* traffic-gen - TrafficGen is a handy performance testing tool that uses core KumoMTA speed to generate high-volume injection testing SMTP messages. Usage instructions are available with `/opt/kumomta/sbin/traffic-gen --help`
* tailer - Tailer provides a flexible command line tool for tracing log activity in real-time without having to `tail -f` the actual logs. It allows you to filter for specific patterns or evaluate a specific batch size of log lines. Usage instructions are available with `/opt/kumomta/sbin/tailer --help` More details can be found [here](./logs.md#using-tailer).
* proxy-server - KumoProxy is a functional socks5 proxy server that can run independently from KumoMTA. Usage instructions are available with `/opt/kumomta/sbin/proxy-server --help`
* accounting.sh - a helpful tool to show volumes of messages sent and received in a calendar month. This can be helpful for your own purposes in tracking monthly and annual volume.
* resolve-shaping-domain - this will show a list of all of the shaping factors in play for a specific domain including custom settings as weel as system defaults
* toml2jsonc - As implied by the name, will convert a TOML file to JSON.
* explain-throttle - explains how a throttle is interpreted by Kumomta
* resolve-queue-config - similar to `resolve-shaping-domain` but will show queue settings for that particular domain or MX
* resolve-site-name - provides the result of how KumoMTA sees the MX-Rollup for the target domain. For instance `/opt/kumomta/sbin/resolve-site-name kumomta.com` results in `smtp.google.com`
* tls-probe can be used in two ways. With the `probe` option, if can test if an MX supports STARTTLS. With the list-rustls-cipher-suites options, it will show all cipher suites supported by rustls.
* kcli - KumoMTA Command Line Interface (KCLI) is a useful tool for accessing the HTTP API directly from the command line. Usage instructions are available with `/opt/kumomta/sbin/kcli --help` More details can be found [here](./kcli.md).
* kumod - this is the actual KumoMTA daemon and is just listed here for completeness.