Utiliser l’interface CLI

Pilotez Beam Bench depuis un terminal. Ouvrez des projets, effectuez le rendu de canevas, inspectez l’état et exportez des fichiers.

Le binaire beambench-cli est généré avec l’application Beam Bench. Utilisez-le pour les scripts, les opérations par lots et le rendu sans interface graphique.

Prérequis

Beam Bench installé (ou le dépôt récupéré, si vous effectuez une compilation depuis les sources).
Un terminal (Terminal sur macOS, PowerShell sur Windows, n’importe quel interpréteur de commandes sous Linux).
Pour certaines commandes : l’application en cours d’exécution. La plupart ne l’exigent pas.

Le binaire s’appelle beambench-cli et est installé avec l’application de bureau. Le chemin exact dépend de la disposition du paquet de la plateforme pour votre compilation actuelle ; vérifiez le répertoire d’installation.

Vous pouvez vouloir l’ajouter à votre PATH ou lui créer un alias pour plus de concision :

alias bb=beambench-cli

Les exemples ci-dessous utilisent le nom complet beambench-cli.

Étapes

1. Vérifier que l’interface CLI fonctionne

beambench-cli --help

Répertorie toutes les sous-commandes. Chaque sous-commande possède sa propre option --help.

2. Inspecter l’état de l’agent

beambench-cli agent state --json

Renvoie un export JSON du projet actuel, de la connexion machine, de la sélection et de l’état de la caméra. Utile pour les scripts et le débogage.

3. Effectuer le rendu du canevas vers un PNG (sans interface graphique)

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

Effectue le rendu de la conception du projet actuel (sans superposition de caméra) vers un PNG. Fonctionne sans que l’interface graphique soit en cours d’exécution.

4. Effectuer le rendu avec la superposition de caméra (nécessite l’interface graphique)

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

Capture le canevas avec le cadre de superposition de caméra actuel. L’application de bureau doit être en cours d’exécution : l’interface CLI lui envoie un RPC inversé, puis l’application effectue le rendu et écrit le fichier.

5. Ouvrir un projet

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

Le chemin est positionnel. Pour enregistrer à nouveau, utilisez beambench-cli project save (sans argument, écrase le fichier ouvert) ou beambench-cli project save-as /abs/path/to/new.lzrproj.

6. Exporter des fichiers

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

Les exportations SVG, DXF, PDF, EPS et AI utilisent --path. Le G-code utilise deux arguments positionnels : le fichier .lzrproj d’entrée et le fichier .gcode de sortie.

7. Inspecter les ports / capacités

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

agent capabilities renvoie le schéma de ce que l’interface CLI peut faire. agent guide renvoie un flux de travail d’amorçage pour les agents externes.

Ce que l’interface CLI ne peut pas faire

Sélectionner un outil du canevas.
Ouvrir ou fermer un panneau / une boîte de dialogue.
Déclencher un raccourci clavier.
Effectuer un glisser-déposer sur le canevas.

Pour ces actions, pilotez directement l’interface graphique (par exemple via l’utilisation d’un ordinateur ou AppleScript), et non via l’interface CLI.

Exemples

Effectuer le rendu par lots de chaque projet d’un dossier

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

Prendre un instantané de l’état de la machine chaque minute

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

Vérifier que cela a fonctionné

beambench-cli --help s’exécute sans erreur.
Un design render produit un PNG de taille non nulle.
agent state renvoie du JSON valide.