Appearance
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 the four binaries: the burrowee dispatcher, burrowee-cli, burrowee-gateway, and burrowee-edge — 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 burrowee-register for local-service bridging) | The home or office machine behind NAT |
burrowee-edge | Your own self-hosted relay | A VPS or LAN host you control |
burrowee gateway status and burrowee-gateway status are the same command — the dispatcher strips the component word and execs the component binary. Examples throughout this section use whichever form reads best.