README.md

ESC: Email Search Command

(Or: Email Sucks Completely)

ESC is a simple proof-of-concept toy I'm hacking together because I want to
play with Tantivy and would quite like a fast command-line email search tool.

It can index my ~2 million-strong ~/Maildir in under three minutes on my 12
core Westmere Xeon with a couple of SSDs, and answer most queries in under 40ms.

If you want a useful email search tool, I recommend notmuch. I hacked most
of this together while waiting for notmuch new to catch up a few tens of
thousands of messages, and it needs a lot of love to be more than a vague
curiosity.

The name is a homage to HSC, the static website generator I used in the late
1990's. Because why not. Email does suck.

Synopsis

Indexing is multithreaded: one walks your maildirs, read-threads threads read
and parse the emails, and index-threads write them to the search index. You
should adjust them to taste based on available IO and CPU and how much data you
have to index.

If no index directory is specified, it defaults to /tmp/email-sucks-completely.