Reference

Configuration

octomux keeps everything under ~/.octomux/ and nothing leaves your machine.

Files

Path	What it holds
`~/.octomux/settings.json`	Defaults written by `octomux init` — harness, model, integrations.
`~/.octomux/octomux.yml`	The plugin manifest. Create it if it does not exist.
`~/.octomux/plugin-load-report.json`	What loaded last boot. `octomux doctor` reads this and works without a running server.

The plugin manifest

# ~/.octomux/octomux.yml
plugins:
  - id: myplugin           # must match ^[a-z0-9][a-z0-9-]*$
    name: my-plugin-pkg    # npm package name, or an absolute path

The id is the namespace every registration from that package is qualified under. Restart after editing, then run octomux doctor.

Recovering a broken boot

A plugin that throws at registration is reported in the load report rather than crashing the server. If one does take the boot down, start with plugins disabled:

octomux start --safe-mode

Privacy

Everything runs locally. No cloud sync, no telemetry, and your .env stays where it is. octomux never calls a model API itself — it passes a model choice down to the harness, which uses the subscription you already pay for.