The dotbot CLI#
One CLI for the whole DotBot workflow: build firmware, flash one board, control a whole swarm, and launch the host-side processes that tie it together - from one bot to a thousand.
dotbot --help
The four commands#
dotbot has four top-level commands - pick by what you’re doing right now:
Command |
What it does |
Reach for it when… |
|---|---|---|
Build, fetch, and list firmware files. No hardware needed. |
You want a |
|
Flash one cabled board and read its info. |
A DotBot or DK is plugged into your USB port right now. |
|
Drive the whole fleet over the air - status, OTA flash, start/stop, monitor. |
You’re operating many provisioned bots through a gateway. |
|
Start host processes on your computer - controller, gateway bridge, simulator, demos, teleop. |
You need the web UI, a gateway bridge, the simulator, or a demo. |
Beyond the four namespaces, config scaffolds and inspects the
shared dotbot.toml the other commands read their defaults from.
Which one do I want?#
Do I have hardware?
├── No ─────────────────────────► fw (build/fetch artifacts, simulator under run)
└── Yes
├── One board on a cable ─────► device (flash app/role, read info)
└── A fleet over the air ─────► swarm (status, OTA flash, start/stop)
Need a process running on my computer (UI, gateway bridge, demo)? ─► run
A few signposts so the namespaces don’t blur together:
fwnever touches hardware. It only produces or lists artifacts in./artifacts/. Flashing always happens underdevice(cabled) orswarm(OTA).Bare vs. sandbox artifacts.
fwbuilds bare apps (.hex) by default;fw artifacts --sandboxbuilds TrustZone apps (.bin) - the payloadswarmflashes over the air.Same word, different object.
dotbot device flash-mari-gatewayflashes firmware onto a board;dotbot run gatewaystarts the host bridge process. They are not the same thing.A DotBot v3 has an on-board programmer. Normal flashing over USB-C needs no external probe - a separate J-Link is only for
dotbot device flash-programmer.
Next#
fw- build, fetch, and list firmware artifacts.device- flash and inspect one cabled board.swarm- run experiments across the fleet.run- launch the controller, gateway bridge, simulator, and demos.config- scaffold and inspect the shareddotbot.toml.
Two end-to-end walkthroughs put these together: build and flash one board, and operate a swarm over the air.