Command Shape
The client reads message data from standard input for message-oriented commands. Commands that only inspect configuration or connectivity, such as ping and genkey, do not require message input.
ruzor [options] commandCommands
| Command | Use | Reads stdin |
|---|---|---|
check | Query report and whitelist counts for each digest. | Yes |
info | Print detailed count and timestamp data. | Yes |
report | Report message digests as spam. | Yes |
whitelist | Report message digests as not-spam. | Yes |
ping | Verify server reachability. | No |
pong | Test command that returns a fixed positive response. | Yes |
digest | Print the Pyzor digest without contacting a server. | Yes |
predigest | Print normalized text before hashing. | Yes |
genkey | Generate account key material. | Interactive |
local_whitelist | Add a digest to the local client whitelist. | Yes |
local_unwhitelist | Remove a digest from the local whitelist. | Yes |
Servers File
The client contacts every server listed in the configured servers file. Use public.ruzor.org:24441 for the public Ruzor service endpoint.
mkdir -p ~/.ruzor
cat > ~/.ruzor/servers <<'EOF'
public.ruzor.org:24441
127.0.0.1:24441
EOF
ruzor pingInput Styles
| Style | Meaning | Example |
|---|---|---|
msg | One RFC message from stdin. | ruzor check < message.eml |
mbox | An mbox file containing multiple messages. | ruzor -s mbox digest < mail.mbox |
digests | One digest per line, no message parsing. | ruzor -s digests check < digests.txt |
Common Options
--homedir DIR
--servers-file FILE
--accounts-file FILE
--local-whitelist FILE
--log-file FILE
-s, --style msg|mbox|digests
-t, --timeout SECONDS
-r, --report-threshold COUNT
-w, --whitelist-threshold COUNT
-d, --debug
-n, --nice NICELocal Whitelist
The local whitelist is client-side. If a digest is locally whitelisted, check returns the local result without depending on the remote server response.
ruzor local_whitelist < false-positive.eml
ruzor check < false-positive.eml
ruzor local_unwhitelist < false-positive.eml