| name | rhombus-cli |
| description | Operate the Rhombus physical-security platform (cameras, access control, sensors, alerts, footage) from the terminal using the official rhombus CLI. Use when a task involves checking camera or device status, pulling alerts or events, reviewing or stitching footage, managing access control, or automating anything in a Rhombus deployment. |
Rhombus CLI
Official CLI for the Rhombus public API — ~60 service groups covering cameras, access control, sensors, alerts, footage, locations, users, and webhooks.
Setup
- Install:
brew install RhombusSystems/tap/rhombus (or see README for shell/PowerShell installers).
- Authenticate, either:
rhombus login — interactive browser OAuth, stores a key locally; or- set
RHOMBUS_API_KEY — create a key in the Rhombus Console.
Usage patterns
- Discover commands:
rhombus --help, then rhombus <group> --help.
- Command names are kebab-case API operations:
rhombus camera get-minimal-camera-state-list, rhombus alert get-recent-alerts, rhombus door get-door-state-list.
- Output is JSON — pipe to
jq for extraction.
- Common flows:
- Device health:
rhombus camera get-minimal-camera-state-list
- Recent alerts:
rhombus alert group
- Footage review:
rhombus analyze (AI analysis of a camera + time window), rhombus stitch (multi-camera clip assembly)
- Natural-language queries:
rhombus chat
- Bandwidth & analytics metrics:
rhombus report get-count-report-v2 --scope DEVICE --uuid <cam> --types '["BANDWIDTH"]' --interval HOURLY --start-time-ms <ms> --end-time-ms <ms> — other types: CROWD, PEOPLE, FACES, MOTION, VEHICLES, LICENSEPLATES, ALERTS, DWELL. Note: --help lists flag names but not accepted enum values; consult the OpenAPI spec (below) for the valid values of any param.
References
