matterbox / Docs

Documentation

Reference pages for the two parts of matterbox that are worth writing down at length: the automation the listen daemon runs, and the database every message you have read is already sitting in.

Rules →

Event automation for matterbox listen. Match on channel, author, text, mention, reaction — or the clock — then notify, run a command, POST a webhook, post back or react. With a rolling-window rate limiter and a persistent ledger, so a rule can count and remember.

The message database →

The local SQLite cache: the schema, what hides in raw_json, and a pile of copy-pasteable queries for the read-only SQL tab.

Everything else

The rest of matterbox documents itself, from the code, so it cannot drift. Every keyboard action, its default key and your overrides:

$ matterbox keys              # --json for the machine-readable form

Every subcommand, its flags and an example:

$ matterbox help
$ matterbox help listen

And ~/.config/matterbox/config.yaml writes itself on first run with a comment over every key — so the file on your disk is the option reference, already filled in with what you chose.

Start at the landing page for what matterbox is and how to install it, or the repository for the source and the issue tracker.