> ## 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.

# Rhombus CLI

> Gestiona cámaras, puertas, alertas y sensores de Rhombus desde la línea de comandos: une video, monitorea alertas y conversa con herramientas de IA.

<Note>
  Esta página fue traducida automáticamente. Si encuentra errores o tiene sugerencias, [contáctenos](mailto:support@rhombus.com).
</Note>

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

<Tabs>
  <Tab title="Homebrew (macOS/Linux)">
    ```bash theme={null}
    brew install RhombusSystems/tap/rhombus
    ```
  </Tab>

  <Tab title="Script de shell (macOS/Linux)">
    ```bash theme={null}
    curl -fsSL https://raw.githubusercontent.com/RhombusSystems/rhombus-cli/main/install.sh | sh
    ```

    En Linux, esto utiliza automáticamente paquetes `.deb` o `.rpm` cuando se detecta un gestor de paquetes compatible.
  </Tab>

  <Tab title="PowerShell (Windows)">
    ```powershell theme={null}
    irm https://raw.githubusercontent.com/RhombusSystems/rhombus-cli/main/install.ps1 | iex
    ```
  </Tab>

  <Tab title="Desde el código fuente">
    Requiere Go 1.26+:

    ```bash theme={null}
    git clone https://github.com/RhombusSystems/rhombus-cli.git
    cd rhombus-cli
    make install
    ```
  </Tab>
</Tabs>

## Autenticar

<Tabs>
  <Tab title="Inicio de sesión por navegador (recomendado)">
    ```bash theme={null}
    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.
  </Tab>

  <Tab title="Configuración manual">
    ```bash theme={null}
    rhombus configure
    ```

    Solicita una API key, formato de salida y URL del endpoint. Úsalo cuando ya tienes una API key de la [Consola de Rhombus](https://console.rhombussystems.com/settings/api-management/).
  </Tab>

  <Tab title="Variable de entorno">
    ```bash theme={null}
    export RHOMBUS_API_KEY=YOUR_API_KEY
    ```

    Sobrescribe las credenciales almacenadas. Útil para pipelines de CI/CD y scripts.
  </Tab>
</Tabs>

### Perfiles

Gestiona múltiples cuentas o entornos con perfiles nombrados:

```bash theme={null}
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:

```bash theme={null}
rhombus <resource> <operation> [flags]
```

### Ejemplos comunes

<CodeGroup>
  ```bash Cameras theme={null}
  # 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
  ```

  ```bash Access Control theme={null}
  # List all doors
  rhombus door-controller get-doors-for-org

  # Grant access to a door
  rhombus door-controller grant-access --door-uuid YOUR_DOOR_UUID
  ```

  ```bash Alerts & Events theme={null}
  # List recent policy alerts
  rhombus event get-policy-alerts-v2

  # Get alert details with bounding boxes
  rhombus event get-policy-alert-details --alert-uuid YOUR_ALERT_UUID
  ```

  ```bash Locations & Users theme={null}
  # List locations
  rhombus location get-locations

  # List users in your org
  rhombus user get-users-in-org
  ```
</CodeGroup>

### Entrada JSON para solicitudes complejas

Para endpoints con cuerpos de solicitud complejos, usa `--cli-input-json`:

```bash theme={null}
# 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
```

<Tip>
  Usa `--generate-cli-skeleton` en cualquier comando para ver todos los parámetros aceptados como una plantilla JSON.
</Tip>

### 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

```bash theme={null}
# 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

```bash theme={null}
# 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

```bash theme={null}
# 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:

```bash theme={null}
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`.

```bash theme={null}
# 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.

```bash theme={null}
# 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.

```bash theme={null}
# 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.

```bash theme={null}
# Interactive chat
rhombus chat

# Voice-powered chat (requires sox and whisper-cpp)
rhombus voice --model base
```

<Note>
  El modo de voz requiere [sox](https://sox.sourceforge.net/) para la captura de audio y [whisper-cpp](https://github.com/ggerganov/whisper.cpp) para conversión de voz a texto.
</Note>

## Banderas globales

| Bandera          | Descripción                                                         |
| ---------------- | ------------------------------------------------------------------- |
| `--profile`      | Perfil de configuración (predeterminado: `"default"`)               |
| `--output`       | Formato de salida: `json`, `table`, `text` (predeterminado: `json`) |
| `--api-key`      | Sobrescribe la API key para este comando                            |
| `--endpoint-url` | Sobrescribe la URL del endpoint de la API                           |
| `--partner-org`  | Nombre 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:

```bash theme={null}
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

| Variable               | Descripción                                      |
| ---------------------- | ------------------------------------------------ |
| `RHOMBUS_API_KEY`      | API key (sobrescribe el archivo de credenciales) |
| `RHOMBUS_PROFILE`      | Nombre del perfil (predeterminado: `default`)    |
| `RHOMBUS_OUTPUT`       | Formato de salida: `json`, `table`, `text`       |
| `RHOMBUS_ENDPOINT_URL` | Sobrescritura del endpoint de la API             |

## Archivos de configuración

| Ruta                          | Propósito                                                        |
| ----------------------------- | ---------------------------------------------------------------- |
| `~/.rhombus/config`           | Formato de salida predeterminado, URL del endpoint (formato INI) |
| `~/.rhombus/credentials`      | API 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

| SO      | Arquitecturas |
| ------- | ------------- |
| macOS   | amd64, arm64  |
| Linux   | amd64, arm64  |
| Windows | amd64, arm64  |

## Recursos

<CardGroup cols={2}>
  <Card title="Repositorio de GitHub" icon="github" href="https://github.com/RhombusSystems/rhombus-cli">
    Código fuente, lanzamientos y rastreador de incidencias
  </Card>

  <Card title="Referencia de la API" icon="code" href="/api-reference/overview">
    Documentación completa de endpoints para las más de 900 operaciones de la API
  </Card>

  <Card title="Monitoreo por WebSocket" icon="signal-stream" href="/es/websocket/overview">
    Detalles del protocolo de streaming de eventos en tiempo real
  </Card>

  <Card title="Límites de tasa" icon="gauge" href="/es/rate-limits">
    Limitación de tasa de la API y guía de reintentos
  </Card>
</CardGroup>