Skip to content

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.

PageWhat it covers
CommandsComplete 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 & filesThe ~/.burrowee/<component>/ layouts — what each file holds, plus service unit names and paths and the unix socket locations.
PortsEvery well-known port in the system, in one table: who binds it, where, and why.
TroubleshootingSymptom → cause → fix tables, grouped by component.

Quick orientation

Burrowee ships three installable components plus a dispatcher:

BinaryRoleWhere it runs
burroweeUniversal entry command — dispatches to the installed component binaries, falls through to the CLIEverywhere (bundled with every install)
burrowee-cliThe client you connect fromYour laptop / workstation
burrowee-gatewayThe machine you connect to (plus burrowee-register for local-service bridging)The home or office machine behind NAT
burrowee-edgeYour own self-hosted relayA 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.