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.

Before you start: about consistency

Results will vary based on your frontier configuration.

The frontier model you use as the orchestrator (Claude Code is the proven path today; other frontiers tracked in #179) needs proper guidance to make the most out of darkmux. This guide is a starting reference, not doctrine to enforce. Contradictory statements between this guide, your project's CLAUDE.md, and other frontier configs will cause more harm than good. Configure to your own strategy and goals; treat what's below as inspiration, not commandments.

darkmux deliberately leaves the operator in control of how their environment is shaped. The same command (darkmux crew dispatch, say) can feel different from one machine to another because the frontier driving it reads different doctrine. That's by design; see the operator-sovereignty thread for the architectural reasoning. The trade-off: don't expect identical experiences across operators. Expect consistent foundations (the CLI, the records, the viewer) and operator-shaped behavior on top.

Where to go from here

No troubleshooting page yet. That comes after the first round of operator feedback shapes which failure modes are worth dedicating a page to. For now, darkmux doctor's output is the canonical troubleshooting surface.

Want the precise model rather than a walkthrough: role families, the mission/sprint schema, telemetry, the flow record, and what's shipped vs. planned? See the concepts reference, the canonical reference for what darkmux is made of.

How darkmux is meant to be used

A complement to your frontier orchestrator, not a replacement.

darkmux is an AI-first local-AI orchestrator: a CLI that manages local LLM stacks on your machine and dispatches utility-agent models internally for bounded structuring tasks (compaction, sprint estimation, mission proposal; see #115). The strategic reasoning loop lives in your frontier orchestrator: Claude Code today, with other frontiers (Gemini, Codex, Copilot) tracked in #179. The utility agent absorbs the routine bounded work; the orchestrator stays on strategy.

The intended division of labor:

This guide assumes you have an orchestrator and want to use darkmux as the local-tier resource it dispatches to. If you're running darkmux purely as a CLI (no orchestrator), most of the guide still applies: just skip the agentic sections (crew dispatch, sprint review).