Beam Bench-dokumentation

Använda CLI:t

Styr Beam Bench från en terminal. Öppna projekt, rendera arbetsytor, granska tillstånd och exportera filer.

Binärfilen beambench-cli byggs tillsammans med Beam Bench-appen. Använd den för skriptning, batchåtgärder och huvudlös rendering.

Det här behöver du

  • Beam Bench installerat (eller repot utcheckat om du bygger från källkod).
  • En terminal (Terminal på macOS, PowerShell på Windows eller valfritt skal på Linux).
  • För vissa kommandon: appen körs. De flesta kräver inte det.

Var du hittar den

Binärfilen heter beambench-cli och installeras tillsammans med datorappen. Den exakta sökvägen beror på paketeringen för din aktuella version; kontrollera installationsmappen.

Du kan lägga till den i din PATH eller skapa ett alias för kortare kommandon:

alias bb=beambench-cli

Exemplen nedan använder det fullständiga namnet beambench-cli.

Steg

1. Kontrollera att CLI:t fungerar

beambench-cli --help

Visar alla underkommandon. Varje underkommando har sin egen --help.

2. Granska agentens tillstånd

beambench-cli agent state --json

Returnerar en JSON-dump av det aktuella projektet, maskinanslutningen, markeringen och kameratillståndet. Användbart för skriptning och felsökning.

3. Rendera arbetsytan till en PNG-fil (huvudlöst)

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

Renderar det aktuella projektets design (utan kameraöverlagring) till en PNG-fil. Fungerar utan att det grafiska gränssnittet körs.

4. Rendera med kameraöverlagring (kräver grafiskt gränssnitt)

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

Fångar arbetsytan med den aktuella kameraöverlagringen. Kräver att datorappen körs. CLI:t skickar ett omvänt RPC-anrop till appen, som utför renderingen och skriver filen.

5. Öppna ett projekt

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

Sökvägen anges som ett positionsargument. Om du vill spara tillbaka använder du beambench-cli project save (utan argument, skriver över den öppna filen) eller beambench-cli project save-as /abs/path/to/new.lzrproj.

6. Exportera filer

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

SVG-, DXF-, PDF-, EPS- och AI-exporter använder --path. G-code använder två positionsargument: indata .lzrproj och utdata .gcode.

7. Granska portar och funktioner

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

agent capabilities returnerar schemat för vad CLI:t kan göra. agent guide returnerar ett startarbetsflöde för externa agenter.

Vad CLI:t inte kan göra

  • Välja ett verktyg på arbetsytan.
  • Öppna eller stänga en panel eller dialogruta.
  • Utlösa ett kortkommando.
  • Dra och släppa på arbetsytan.

För detta styr du det grafiska gränssnittet direkt (till exempel via computer-use eller AppleScript), inte via CLI:t.

Exempel

Batchrendera alla projekt i en mapp

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

Ta en ögonblicksbild av maskinens tillstånd varje minut

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

Kontrollera att det fungerade

  • beambench-cli --help körs utan fel.
  • design render skapar en PNG-fil som inte är tom.
  • agent state returnerar giltig JSON.

Relaterat

On this page