CLIの使用

ターミナルからBeam Benchを操作します。プロジェクトを開き、キャンバスをレンダリングし、状態を確認してファイルをエクスポートします。

beambench-cliバイナリはBeam Benchアプリと同時にビルドされます。スクリプト作成、バッチ操作、ヘッドレスレンダリングに使用できます。

必要なもの

Beam Benchがインストールされていること（またはソースからビルドする場合はリポジトリをチェックアウトしていること）。
ターミナル（macOSではターミナル、WindowsではPowerShell、Linuxでは任意のシェル）。
一部のコマンドではアプリが起動していること。ほとんどのコマンドでは必要ありません。

CLIの場所

バイナリ名は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はreverse-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の2つを指定します。

7. ポートと機能を確認する

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

agent capabilitiesはCLIで実行できる操作のスキーマを返します。agent guideは外部エージェント向けの初期化ワークフローを返します。

CLIでできないこと

キャンバスツールを選択する。
パネルやダイアログを開閉する。
ホットキーを実行する。
キャンバス上でドラッグアンドドロップする。

これらの操作には、CLIではなくGUIを直接操作してください（例：computer-useまたはAppleScript）。

例

フォルダー内のすべてのプロジェクトを一括レンダリングする

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を返す。