Reference

The guides walk you through tasks; this section is the lookup material — every command and flag, every file each component writes, every port it binds, and a symptom-indexed troubleshooting table.

Page	What it covers
Commands	Complete command reference for every user-facing binary: the burrowee dispatcher, burrowee-cli, the gateway trio (burrowee-gateway + burrowee-gateway-cli + burrowee-register), the edge pair (burrowee-edge + burrowee-edge-cli), and the three component updaters — every subcommand and flag, plus exit codes.
Config homes & files	The ~/.burrowee/<component>/ layouts — what each file holds, plus service unit names and paths and the unix socket locations.
Ports	Every well-known port in the system, in one table: who binds it, where, and why.
Troubleshooting	Symptom → cause → fix tables, grouped by component.

Quick orientation

Burrowee ships three installable components plus a dispatcher:

Binary	Role	Where it runs
burrowee	Universal entry command — dispatches to the installed component binaries, falls through to the CLI	Everywhere (bundled with every install)
burrowee-cli	The client you connect from	Your laptop / workstation
burrowee-gateway	The machine you connect to — plus its burrowee-gateway-cli sibling (operator verbs) and burrowee-register (local-service bridging)	The home or office machine behind NAT
burrowee-edge	Your own self-hosted relay — plus its burrowee-edge-cli sibling (setup + lifecycle)	A VPS or LAN host you control

Gateway and edge are each split into a thin daemon plus an operator -cli sibling. The dispatcher hides the split: burrowee gateway status routes straight to burrowee-gateway-cli status, since status isn't one of the few runtime verbs (run/serve/update/version) the bare burrowee-gateway binary understands. Examples throughout this section use the dispatcher form; see Commands for exactly which verbs go where.