Documentación de Beam Bench

Usar la CLI

Controla Beam Bench desde un 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.

Qué necesitas

  • Beam Bench instalado (o el repositorio clonado, si compilas desde el código fuente).
  • Un 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 necesitan.

Dónde encontrarlo

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 para la compilación actual; consulta el directorio de instalación.

Quizá quieras añadirlo a la variable PATH o crear un alias para abreviar:

alias bb=beambench-cli

Los ejemplos siguientes utilizan el nombre completo beambench-cli.

Pasos

1. Comprobar que la CLI funciona

beambench-cli --help

Enumera todos los subcomandos. Cada subcomando tiene su propia opción --help.

2. Inspeccionar el estado del agente

beambench-cli agent state --json

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

3. Renderizar el lienzo como PNG (sin interfaz gráfica)

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

Renderiza como PNG el diseño del proyecto actual (sin la superposición de cámara). Funciona sin que se ejecute la interfaz gráfica.

4. Renderizar con la 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 fotograma actual de la superposición de cámara. La aplicación de escritorio debe estar en ejecución: la CLI envía una llamada RPC inversa a la aplicación, que renderiza la imagen y escribe el archivo.

5. Abrir un proyecto

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

La ruta es un argumento posicional. Para guardar en el mismo archivo, utiliza beambench-cli project save (sin argumentos; sobrescribe el archivo abierto) o beambench-cli project save-as /abs/path/to/new.lzrproj.

6. Exportar 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 a SVG, DXF, PDF, EPS y AI utilizan --path. G-code requiere dos argumentos posicionales: el archivo de entrada .lzrproj y el archivo de salida .gcode.

7. Inspeccionar los puertos y las capacidades

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

agent capabilities devuelve el esquema de las operaciones que puede realizar la CLI. agent guide devuelve un flujo de trabajo de arranque para agentes externos.

Lo que la CLI no puede hacer

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

Para esas operaciones, 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

Capturar el estado de la máquina cada minuto

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

Comprobar que ha funcionado

  • beambench-cli --help se ejecuta sin errores.
  • Una llamada a design render genera un PNG de tamaño distinto de cero.
  • agent state devuelve un JSON válido.

Temas relacionados

On this page