matterbox / Docs

Documentation

Reference pages for the parts of matterbox worth writing down at length: how to get it onto a machine, every key in the config file, the commands you can put in a script, the automation the listen daemon runs, and the database every message you have read is already sitting in.

Installation →

The one-line installer and every flag it takes, a source build and the optional features it unlocks — inline video, the demo soundtrack — the listen service, upgrading and uninstalling.

Configuration →

Every key in config.yaml, and when a change to it takes effect: the server, reading and display, keybindings, search and the local models, the listen daemon, Jira and GitLab.

The CLI →

Every subcommand, and what to script with it. JSON Lines out of read, unread, search and digest; stdin into send; blocking on the next message instead of polling for it.

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.

Telemetry →

Off unless you turned it on — and if you did, this is the whole of it: every event, every property, the closed set of values each one can hold, and what is never sent whatever you switch on.

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 — the authority the CLI page follows:

$ 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. The configuration page is the long version of it.

Start at the landing page for what matterbox is, the installation page for getting it onto a machine, or the repository for the source and the issue tracker.