Documentación de Beam Bench

Uso de la CLI

Controla Beam Bench desde una terminal. Abre proyectos, renderiza lienzos, inspecciona el estado y exporta archivos.

El binario beambench-cli se compila junto con la aplicación Beam Bench. Úsalo para crear scripts, realizar operaciones por lotes y renderizar sin interfaz gráfica.

Lo que necesitas

  • Beam Bench instalado (o el repositorio clonado, si compilas desde el código fuente).
  • Una terminal (Terminal en macOS, PowerShell en Windows o cualquier shell en Linux).
  • Para algunos comandos: la aplicación en ejecución. La mayoría no la requiere.

Dónde encontrarla

El binario se llama beambench-cli y se instala junto con la aplicación de escritorio. La ruta exacta depende de la estructura del paquete de la plataforma correspondiente a tu compilación actual; consulta el directorio de instalación.

Puedes agregarlo a tu PATH o crear un alias para escribirlo más rápido:

alias bb=beambench-cli

En los ejemplos siguientes se usa el nombre completo beambench-cli.

Pasos

1. Verifica que la CLI funcione

beambench-cli --help

Muestra todos los subcomandos. Cada subcomando tiene su propio --help.

2. Inspecciona el estado del agente

beambench-cli agent state --json

Devuelve un volcado JSON del proyecto actual, la conexión de la máquina, la selección y el estado de la cámara. Es útil para crear scripts y depurar.

3. Renderiza el lienzo a un PNG (sin interfaz gráfica)

beambench-cli design render --png /tmp/out.png --pixels-per-mm 4

Renderiza el diseño del proyecto actual (sin la superposición de cámara) a un PNG. Funciona sin que la interfaz gráfica esté en ejecución.

4. Renderiza con superposición de cámara (requiere la interfaz gráfica)

beambench-cli camera overlay render --output /tmp/overlay.png --view fit

Captura el lienzo con el marco de superposición de la cámara actual. Requiere que la aplicación de escritorio esté en ejecución; la CLI envía una solicitud RPC inversa a la aplicación, que realiza el renderizado y escribe el archivo.

5. Abre un proyecto

beambench-cli project open /abs/path/to/project.lzrproj

La ruta es posicional. Para volver a guardar, usa beambench-cli project save (sin argumentos, sobrescribe el archivo abierto) o beambench-cli project save-as /abs/path/to/new.lzrproj.

6. Exporta archivos

beambench-cli export svg --path /abs/path/out.svg
beambench-cli export gcode /abs/path/to/project.lzrproj /abs/path/out.gcode

Las exportaciones SVG, DXF, PDF, EPS y AI aceptan --path. G-code acepta dos argumentos posicionales: el .lzrproj de entrada y el .gcode de salida.

7. Inspecciona los puertos y las capacidades

beambench-cli ports
beambench-cli agent capabilities --json
beambench-cli agent guide --json

agent capabilities devuelve el esquema de lo que la CLI puede hacer. agent guide devuelve un flujo de trabajo inicial para agentes externos.

Lo que la CLI no puede hacer

  • Seleccionar una herramienta del lienzo.
  • Abrir o cerrar un panel o diálogo.
  • Activar un atajo de teclado.
  • Arrastrar y soltar en el lienzo.

Para esas acciones, controla directamente la interfaz gráfica (por ejemplo, mediante computer-use o AppleScript), no mediante la CLI.

Ejemplos

Renderizar por lotes todos los proyectos de una carpeta

for f in /path/to/projects/*.lzrproj; do
  beambench-cli project open "$f"
  beambench-cli design render --png "${f%.lzrproj}.png" --pixels-per-mm 4
done

Tomar una instantánea del estado de la máquina cada minuto

while true; do
  beambench-cli agent state --json > "/tmp/state-$(date +%s).json"
  sleep 60
done

Verifica que funcione

  • beambench-cli --help se ejecuta sin errores.
  • design render produce un PNG cuyo tamaño es distinto de cero.
  • agent state devuelve JSON válido.

Relacionado

On this page