Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt

Use this file to discover all available pages before exploring further.

Esta página fue traducida automáticamente. Si encuentra errores o tiene sugerencias, contáctenos.
El Rhombus CLI te brinda acceso directo desde la terminal a toda tu plataforma de seguridad Rhombus: más de 60 categorías de recursos de API, además de comandos de alto nivel para unir video, análisis de fotogramas, monitoreo de alertas en tiempo real y chat con IA.

​
Instalar

brew install RhombusSystems/tap/rhombus

​
Autenticar

rhombus login
Abre tu navegador para autenticación OAuth2, luego crea y almacena una API key localmente. Soporta autenticación basada en certificado (mTLS) y basada en token.

​
Perfiles

Gestiona múltiples cuentas o entornos con perfiles nombrados: 
rhombus login --profile staging
rhombus camera get-minimal-camera-state-list --profile staging
Las credenciales se almacenan en ~/.rhombus/credentials (permisos de archivo 600) y la configuración en ~/.rhombus/config.

​
Comandos de API

62 comandos de recursos se generan automáticamente desde la especificación OpenAPI de Rhombus, cubriendo toda la superficie de la API. El patrón general es: 
rhombus <resource> <operation> [flags]

​
Ejemplos comunes

# List all cameras
rhombus camera get-minimal-camera-state-list

# Get detailed camera state
rhombus camera get-full-camera-state --camera-uuid YOUR_CAMERA_UUID

​
Entrada JSON para solicitudes complejas

Para endpoints con cuerpos de solicitud complejos, usa --cli-input-json: 
# Generate a parameter template
rhombus camera get-full-camera-state --generate-cli-skeleton

# Pass parameters as inline JSON
rhombus event get-policy-alerts-v2 --cli-input-json '{"maxResults": 10}'

# Pass parameters from a file
rhombus event get-policy-alerts-v2 --cli-input-json file://params.json
Usa --generate-cli-skeleton en cualquier comando para ver todos los parámetros aceptados como una plantilla JSON.

​
Recursos disponibles

El CLI cubre más de 60 categorías de recursos, incluyendo: access-control, alert-monitoring, audio-gateway, camera, climate, door-controller, doorbell-camera, elevator, event, event-search, export, face-recognition-person, integrations, location, lockdown-plan, occupancy, org, partner, permission, policy, report, rules, scene-query, schedule, search, sensor, user, vehicle, video, webhook-integrations, y más.

​
Comandos de alto nivel

Más allá del acceso directo a la API, el CLI proporciona varios comandos compuestos potentes.

​
Gestión de alertas

# Recent alerts (filter by camera name)
rhombus alert recent --camera "Front Lobby" --max 10

# Download alert thumbnail
rhombus alert thumb ALERT_UUID --output thumb.jpg

# Download alert video clip
rhombus alert download ALERT_UUID --output clip.mp4

# Open alert clip in browser
rhombus alert play ALERT_UUID

​
Grabación en vivo

# Open live view for a camera (by name)
rhombus footage "Front Lobby"

# Jump to a specific time
rhombus footage "Front Lobby" --start "5m ago"
rhombus footage "Front Lobby" --start 1711900800000
Inicia un servidor HTTP local con un reproductor autenticado y abre tu navegador.

​
Monitoreo de alertas en tiempo real

# Stream policy alerts as they fire
rhombus monitor

# Include all event types (not just policy alerts)
rhombus monitor --all-events

# JSON output for piping to other tools
rhombus monitor --json
Conecta vía WebSocket (protocolo STOMP) con reconexión automática. Canaliza la salida --json a jq para filtrar: 
rhombus monitor --json | jq 'select(.deviceName == "Lobby Camera")'

​
Unión de video

Combina grabaciones de varias cámaras en un único video con disposición en cuadrícula. Requiere ffmpeg. 
# Stitch events across cameras at a location
rhombus stitch --location "HQ" --start "2h ago" --end "1h ago"

# Specific cameras with buffer time
rhombus stitch --camera "Entrance" --camera "Lobby" --start "30m ago" --buffer 5
Crea un MP4 con superposiciones de marca de tiempo a partir de eventos en las cámaras seleccionadas.

​
Análisis de fotogramas

Extrae fotogramas muestreados inteligentemente con metadatos de detección de actividad: útil para pipelines de ML. 
# Analyze frames from an alert
rhombus analyze alert ALERT_UUID

# Analyze footage across cameras at a location
rhombus analyze footage --location "HQ" --start "1h ago" --end "30m ago"

# Include motion metadata, output raw frames
rhombus analyze footage "Lobby Cam" --start "2h ago" --include-motion --raw

​
Contexto de implementación

Genera una instantánea estructurada de toda tu implementación: ubicaciones, cámaras, información de hardware, coordenadas e imágenes actuales. 
# Full deployment snapshot
rhombus context generate

# Specific location or camera
rhombus context location "HQ"
rhombus context camera "Front Lobby"

​
Chat con IA (Rhombus MIND)

Interfaz de lenguaje natural para tu implementación de Rhombus. El agente de chat puede ejecutar comandos del CLI en tu nombre. 
# Interactive chat
rhombus chat

# Voice-powered chat (requires sox and whisper-cpp)
rhombus voice --model base
El modo de voz requiere sox para la captura de audio y whisper-cpp para conversión de voz a texto.

​
Banderas globales

BanderaDescripción
--profilePerfil de configuración (predeterminado: "default")
--outputFormato de salida: json, table, text (predeterminado: json)
--api-keySobrescribe la API key para este comando
--endpoint-urlSobrescribe la URL del endpoint de la API
--partner-orgNombre o UUID de la organización del cliente (para cuentas partner)

​
Cuentas partner

Para organizaciones partner/multitenant, usa --partner-org para operar sobre las organizaciones de clientes: 
rhombus camera get-minimal-camera-state-list --partner-org "Acme Corp"
rhombus camera get-minimal-camera-state-list --partner-org ORG_UUID
La coincidencia de nombre no distingue mayúsculas y minúsculas y se basa en subcadenas. Si coinciden varias organizaciones, se te pedirá que selecciones una.

​
Variables de entorno

VariableDescripción
RHOMBUS_API_KEYAPI key (sobrescribe el archivo de credenciales)
RHOMBUS_PROFILENombre del perfil (predeterminado: default)
RHOMBUS_OUTPUTFormato de salida: json, table, text
RHOMBUS_ENDPOINT_URLSobrescritura del endpoint de la API

​
Archivos de configuración

RutaPropósito
~/.rhombus/configFormato de salida predeterminado, URL del endpoint (formato INI)
~/.rhombus/credentialsAPI keys y rutas de certificados por perfil (INI, permisos 600)
~/.rhombus/certs/<profile>/Certificados de cliente y claves privadas
Precedencia de configuración: banderas del CLI > variables de entorno > configuración del perfil > valores predeterminados.

​
Soporte de plataformas

SOArquitecturas
macOSamd64, arm64
Linuxamd64, arm64
Windowsamd64, arm64

​
Recursos

Repositorio de GitHub

Código fuente, lanzamientos y rastreador de incidencias

Referencia de la API

Documentación completa de endpoints para las más de 800 operaciones de la API

Monitoreo por WebSocket

Detalles del protocolo de streaming de eventos en tiempo real

Límites de tasa

Limitación de tasa de la API y guía de reintentos
Last modified on April 30, 2026