8==8 <= A bone.
BONE is an email-driven report tracker – see the principles.
BONE monitors IMAP mailboxes and Maildirs, classifies incoming emails into sources by header matching, detects report types from subject tags, applies commands from email bodies, and manages roles per source.
BONE reports can be read with other tools:
- As a CLI based on fzf: gnaw
- As a standalone GNU Emacs tool: gnaw.el
- Via GNU Emacs Gnus: gnus-gnaw
- Via GNU Emacs notmuch: notmuch-gnaw
- Via GNU Emacs mu4e: mu4e-gnaw
The gnus-gnaw, notmuch-gnaw and mu4e-gnaw front-ends are
unmaintained proofs of concept.
For more extensive documentation, read the BONE manual.
For the codebase, architecture and development setup, see CONTRIBUTING.md.
# 1. Copy and edit the config (minimal: one mailbox, one source)
cp config.edn.minimal config.edn
bb test-config # validate it
# 2a. Run once (fetch new emails, expire, exit)
clj -M:run
# 2b. Run in watch mode (IMAP IDLE or Maildir, stays running)
clj -M:run -- --watch
# 2c. Or build an uberjar and run it (production)
bb build-jar # produces target/bone.jar + bin/bone wrapper
bin/bone --watch
# 3. Export reports to public/
bb export # incremental (skips if nothing changed)
bb export --force # full rebuild, ignore timestamps
# 4. Send notification emails
bb notify --dry-run # preview without sending
bb notify
# 5. Run tests
clj -M:testBONE reads ./config.edn (override with -c <path> or BONE_CONFIG).
Its two required sections are :mailboxes (where the mail comes from:
IMAP or Maildir) and :sources (which mail belongs to which tracker:
matched by List-Id, alias or delivery address).
config.edn.minimalis the smallest working config.config.edn.exampleis the annotated reference of every key.- The manual’s Deploying BONE chapter documents each section: mailboxes, sources, periods, expiry, notifications, theme, logging, production setup.
- Its CLI reference lists every
bbtask and flag.
See CONTRIBUTING.md for reporting bugs, sending patches, and working on the codebase.
You can also send me an email and support my work on liberapay.
This project uses Intentional Versioning. The three audiences:
Users: end-users and sysadmins who operate BONE instancesIntegrators: consumers of the exported JSON/RSS/Org formatsMaintainers: maintainers of the codebase
If you like Clojure(script), consider supporting maintainers by donating to clojuriststogether.org.
Copyright © 2026 Bastien Guerry
The Clojure code is distributed under the Eclipse Public License 2.0 and the JavaScript code under the Mozilla Public License 2.0.