user guide · v1

Using darkmux

Workflow walkthroughs for running darkmux on your own hardware. Pick a section by what you're trying to do. They don't depend on each other in strict order, except Getting Started, which everything else assumes you've done.

Two ways to drive it

Every page here shows the commands. Run them yourself at a terminal, or hand the page to an agent: Claude Code and any harness that reads CLAUDE.md or AGENTS.md can follow the same steps, and darkmux init installs the skills that make that smooth. Nothing in the guide requires an agent in the loop; the mission, review, and crawl workflows also run from the command line and from CI. Where a page shows output, it was captured from a real run and says so.

Where to go from here

01 · Foundation
Getting started
Install, init, first inference, then the checks, a first dispatch, and the viewer. Every step captured from a fresh machine.
02 · First inference
radio: darkmux in plain text
Interactive help from a local model: ask anything about darkmux, get the exact command back. The dial, the editor integration, and how to advertise your own commands.
03 · See it work
Observability: daemon + viewer
Start the daemon, point the /flow viewer at it, watch darkmux operate.
04 · Measure
The lab harness
Run workloads, characterize models, tune knobs, compare results across runs.
05 · Advanced
Missions, phases, dispatch
Structured agentic work: dispatch local-AI roles, track multi-step plans as missions and phases.
06 · Machine setup
Set up an always-on hub
Turn one always-on machine into the fleet's coordinator. Copy/paste, brew-only: password-less Redis bound to your tailnet (never the public internet), the daemon under launchd, audit substrate, log rotation, daily integrity checks.
07 · Machine setup
Join a worker peer
Connect another machine to an existing hub. Start as an observability peer you dispatch to directly; graduate to a full fleet worker for distributed loads when the hardware's ready.
08 · Advanced
PR-flow panel verbs
Author /pr-list, /pr-info, /pr-approve, /pr-merge as slash commands in the agent panel: a per-verb gh allowlist, a permission dialog with real CI/review facts, and a flow-record audit trail.
09 · Advanced
Crawl a codebase against your rules, and route what it finds
Point a workspace spec at a real source tree, name the rules to check, and let a local model crawl it. Every match becomes a queryable finding record; route it further to your own loopback receiver with hooks.

darkmux doctor's output is the canonical troubleshooting surface.

Want the precise model rather than a walkthrough: role families, the mission/phase schema, telemetry, the flow record? See the concepts reference, the canonical reference for what darkmux is made of.

Who does what

Local models do the work. You, or your agent, decide what runs.

darkmux keeps a crew of local models resident on your Apple Silicon and hands them bounded work: implementation, review, crawling, structuring. A small utility model handles the routine internal jobs (compaction, routing for the radio) so the specialists do not have to. Above that sits whoever holds the intent: you at a terminal, a CI job with a config, or a frontier agent such as Claude Code that reads the docs and proposes the commands. darkmux surfaces, suggests, and records; it never substitutes its judgment for yours.

darkmux doctor's output is the canonical troubleshooting surface. For the precise model rather than a walkthrough (role families, the mission and phase schema, telemetry, the flow record), see the concepts reference.