CLI reference

Every command runs inside the container and applies live — no restarts needed:

docker compose exec clacks clacks <command>

Domains & users

clacks domain add <name>              host a domain (generates DKIM keys)
clacks domain list
clacks user add <email> [--admin] [--name "Display Name"] [--password <pw>]
clacks user list
clacks user passwd <email>
clacks user admin add <email>         grant global admin
clacks user admin remove <email> [--force]
clacks alias add <local@domain> <dest@domain>
clacks alias add @domain <dest@domain>        domain catch-all
clacks dns <domain>                   print the DNS records to publish

Operations

clacks stats                          database size, message counts, largest accounts
clacks queue                          pending outbound mail and errors
clacks queue flush                    retry all pending mail now
clacks cert [--force]                 obtain/renew the TLS certificate now
clacks backup                         run a backup now
clacks backup list
clacks backup restore <key> --output <path>
clacks version                        print the running version

Mail import

clacks migrate test --host H --user U [--port P] [--security ssl|starttls]
clacks migrate add <dest@domain> --host H --user U [...]
clacks migrate import <archive.zip> <dest@domain>
clacks migrate list
clacks migrate status <id>
clacks migrate pause|resume|remove <id>

See Importing mail for details and provider notes.