Beam Bench文档

使用CLI

从终端驱动Beam Bench。打开项目、渲染画布、检查状态、导出文档。

beambench-cli二进制文档与Beam Bench应用一同构建。可将其用于脚本编写、批量操作和无头渲染。

所需条件

  • 已安装Beam Bench(如果从源代码构建,也可以检出仓库)。
  • 终端(macOS上的Terminal、Windows上的PowerShell或Linux上的任意shell)。
  • 某些命令需要应用正在运行,大多数命令不需要。

查找位置

二进制文档名为beambench-cli,与桌面应用安装在一起。确切路径取决于当前构建的平台进程包布局;请检查安装目录。

你可以将其添加到PATH,或为简便起见为其创建别名:

alias bb=beambench-cli

以下示例使用完整的beambench-cli名称。

步骤

1. 验证CLI是否正常工作

beambench-cli --help

列出所有子命令。每个子命令都有自己的--help

2. 检查代理状态

beambench-cli agent state --json

返回当前项目、机器连接、选区和相机状态的JSON转储。适用于脚本编写和调试。

3. 将画布渲染为PNG(无头模式)

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

将当前项目的设计(不含相机叠加层)渲染为PNG。无需运行GUI即可工作。

4. 使用相机叠加层渲染(需要GUI)

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

捕获带有当前相机叠加层画面的画布。需要桌面应用正在运行;CLI向应用发送反向RPC,由应用执行渲染并写入文档。

5. 打开项目

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

路径作为位置参数传入。要保存回原文档,请使用beambench-cli project save(无参数,会覆盖打开的文档),或使用beambench-cli project save-as /abs/path/to/new.lzrproj

6. 导出文档

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和AI导出使用--path。G-code使用两个位置参数:输入.lzrproj和输出.gcode

7. 检查端口/功能

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

agent capabilities返回CLI可执行操作的架构。agent guide返回供外部代理使用的引导工作流。

CLI无法执行的操作

  • 选择画布工具。
  • 打开或关闭面板/对话框。
  • 触发快捷键。
  • 在画布上拖放。

对于这些操作,请直接驱动GUI(例如通过computer-use或AppleScript),不要使用CLI。

示例

批量渲染文档夹中的每个项目

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

每分钟获取一次机器状态快照

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

验证是否成功

  • beambench-cli --help无错误运行。
  • design render生成非零大小的PNG。
  • agent state返回有效的JSON。

相关内容

On this page