Command reference generated from the perch command tree. Every command also accepts --help for its installed version.
| Command | Description |
|---|---|
| perch init | create a local configuration and optional first account |
| perch setup | create the mxRaven domain, listeners, keys, and routes |
| perch serve | run IMAP, submission, and the notification consumer |
| perch account | add, list, password, disable, or enable accounts |
| perch alias | manage address aliases and catch-all domains |
| perch mailbox | list mailboxes for an account |
| perch mail | list, search, fetch, and send mail |
| perch doctor | check the database, TLS, S3, and mxRaven connectivity |
| perch backup | write a consistent SQLite backup |
| perch reconcile | force one S3 bucket reconciliation pass |
| perch gc | remove orphan blobs, old dead letters, and S3 tombstones |
| perch outbound | list submitted messages and delivery status |
| perch version | print the version |