Documentação do Beam Bench

Usando a CLI

Controle o Beam Bench pelo terminal. Abra projetos, renderize canvas, inspecione o estado e exporte arquivos.

O binário beambench-cli é compilado junto com o aplicativo Beam Bench. Use-o para scripts, operações em lote e renderização sem interface gráfica.

O que você precisa

  • Beam Bench instalado (ou o repositório baixado, caso compile a partir do código-fonte).
  • Um terminal (Terminal no macOS, PowerShell no Windows, qualquer shell no Linux).
  • Para alguns comandos: o aplicativo em execução. A maioria não exige isso.

Onde encontrá-lo

O binário se chama beambench-cli e é instalado junto com o aplicativo desktop. O caminho exato depende do layout do pacote da plataforma na sua compilação atual; verifique o diretório de instalação.

Talvez você queira adicioná-lo ao seu PATH ou criar um alias para abreviá-lo:

alias bb=beambench-cli

Os exemplos abaixo usam o nome completo beambench-cli.

Etapas

1. Verifique se a CLI funciona

beambench-cli --help

Lista todos os subcomandos. Cada subcomando tem seu próprio --help.

2. Inspecione o estado do agente

beambench-cli agent state --json

Retorna um dump JSON do projeto atual, da conexão com a máquina, da seleção e do estado da câmera. Útil para scripts e depuração.

3. Renderize o canvas em PNG (sem interface gráfica)

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

Renderiza o design do projeto atual (sem sobreposição da câmera) em um PNG. Funciona sem a interface gráfica em execução.

4. Renderize com sobreposição da câmera (requer a interface gráfica)

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

Captura o canvas com o quadro de sobreposição da câmera atual. Exige que o aplicativo desktop esteja em execução; a CLI envia uma RPC reversa ao aplicativo, que faz a renderização e grava o arquivo.

5. Abra um projeto

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

O caminho é posicional. Para salvar de volta, use beambench-cli project save (sem argumentos, sobrescreve o arquivo aberto) ou beambench-cli project save-as /abs/path/to/new.lzrproj.

6. Exporte arquivos

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

As exportações SVG, DXF, PDF, EPS e AI usam --path. O G-code usa dois argumentos posicionais: .lzrproj de entrada e .gcode de saída.

7. Inspecione portas / recursos

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

agent capabilities retorna o esquema do que a CLI pode fazer. agent guide retorna um fluxo de trabalho de inicialização para agentes externos.

O que a CLI não pode fazer

  • Selecionar uma ferramenta do canvas.
  • Abrir ou fechar um painel / caixa de diálogo.
  • Acionar uma tecla de atalho.
  • Arrastar e soltar no canvas.

Para essas ações, controle a interface gráfica diretamente (por exemplo, usando controle por computador ou AppleScript), e não pela CLI.

Exemplos

Renderize em lote todos os projetos de uma pasta

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

Capture o estado da máquina a cada minuto

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

Verifique se funcionou

  • beambench-cli --help é executado sem erro.
  • Um design render produz um PNG com tamanho diferente de zero.
  • agent state retorna JSON válido.

Relacionados

On this page