Reference
The exact surfaces — every roomler command, every agent configuration key, which ports are needed, and how the HTTP API is authenticated and scoped.
Lookup material rather than reading material. If you are trying to understand something, Architecture is the better start; these pages are for when you already know what you want and need the exact spelling.
CLI
— Every roomler command and the flags that actually exist.
Configuration
— Agent config.toml keys, where the file lives per platform, and which settings the server can and cannot change.
Ports and firewall
— What must be reachable, and what never needs opening inbound.
HTTP API
— Authentication, organization scoping, rate limits and route groups.
Two things that catch people
Device selectors are hex ids, not display names
--agent, and the target argument to exec and ssh, take the hex device
id from the dashboard. A friendly name is not resolved, and passing one fails
in a way that looks like the device is missing rather than like a bad argument.
`--help` is authoritative for the version you have
These pages describe the current release. The binary on your machine may be
older or newer, and roomler <command> --help is the truth for it.
In this section
CLI reference
Every roomler command — status, peers, why, netcheck, forwards, routes, exec, ssh and diagnostics — with the flags that actually exist.
Configuration reference
The agent's config.toml — where it lives per platform, the settings worth knowing, and which ones the server can and cannot change.
Ports and firewall
What Roomler needs to reach, what it never needs opened inbound, and the one port range that matters if you self-host video calls.
HTTP API
Roomler's REST API — how it is authenticated, how routes are scoped per organization, and where to find the full route list.