Skip to Content
CLIErste Schritte

Erste Schritte

Hier wird gezeigt, welche die ersten Schritte sind, um die CLI gut nutzen zu können.

Verbindung zur Engine

Port-Konfiguration

Die Ports der Engine haben bei der Einrichtung Standardwerte für die verschiedenen Freigabekanäle:

InstallationsartFreigabekanalStandardport
Enginealpha10580
Enginebeta10570
Enginestable10560
Engine via Studioalpha56200
Engine via Studiobeta56100
Engine via Studiostable56000

Einstieg mit Studio

Nach dem Start des Studios ist die lokale Engine-Instanz (über Cuby) unter http://localhost:56000  verfügbar.

Um sich mit der CLI zu verbinden:

pc engine login http://localhost:56000 --root

Mit pc engine login wird eine Verbindung zu einer Engine-Instanz über die URL hergestellt.

Der Parameter --root wird für Engine-Instanzen verwendet, welche einen anonymen Zugriff erlauben (siehe Referenz).

Verkürzte Schreibweise

Die CLI nimmt als Standardprotokoll http und als Standardhost localhost. Dadurch ist auf Entwicklungssystemen eine verkürzte Schreibweise möglich:

# Vollständig
pc engine login http://localhost:56000 --root
 
# Ohne Protokoll
pc engine login localhost:56000 --root
 
# Nur Port
pc engine login :56000 --root

Verbindung zu einer Remote-Engine

Für produktive Umgebungen mit Authentifizierung:

pc engine login https://engine.processcube.io

Sie werden dann nach Ihren Zugangsdaten gefragt. Die Authority öffnet sich im Browser zur Authentifizierung.

Session-Status prüfen

Um zu prüfen, mit welcher Engine Sie verbunden sind:

pc engine session-status

Ausgabe:

Connected to: http://localhost:56000
User: root

Prozessmodelle auflisten

Um verfügbare Prozessmodelle anzuzeigen:

pc engine list-process-models

Prozess starten

Um einen Prozess zu starten:

pc engine start-process-model my_process StartEvent_1

Mit Payload:

pc engine start my_process StartEvent_1 --start-token '{"orderId": "12345"}'

Prozessinstanz inspizieren

Um die Details einer gestarteten Prozessinstanz anzuzeigen:

pc engine show-process-instance <processInstanceId>

Die Ausgabe enthält den Status, die FlowNode-Instanzen und deren Verlauf. Die processInstanceId erhalten Sie aus der Ausgabe von start-process-model oder list-process-instances.

Prozessinstanzen auflisten

Um laufende Prozessinstanzen anzuzeigen:

pc engine list-process-instances

Für ein bestimmtes Prozessmodell:

pc engine list-process-instances --filter-by-process-model-id my_process

BPMN-Diagramme deployen

Um BPMN-Diagramme zu deployen:

pc engine deploy-files ./diagrams/**/*.bpmn

Abmelden

Um die Verbindung zu beenden:

pc engine logout

Aufruf aus Skripten und Programmen

pc lässt sich problemlos aus Skripten und Programmiersprachen heraus aufrufen. Die CLI prüft stdin nur kurz und läuft sofort weiter, wenn keine Pipe-Daten anliegen — auch wenn der stdin-Filehandle ein offener Pipe ist (Default-stdio bei Node.js child_process.execFile/spawn oder Python subprocess.run(stdin=PIPE)).

// Node.js
import { execFile } from 'node:child_process';
execFile('pc', ['engine', 'lsi', '--filter-by-correlation-id', 'abc', '--output', 'json'],
  (err, stdout) => console.log(stdout));
# Python
import subprocess
result = subprocess.run(
    ['pc', 'engine', 'lsi', '--filter-by-correlation-id', 'abc', '--output', 'json'],
    capture_output=True, text=True,
)
print(result.stdout)

Bis einschließlich CLI v4.10.0 musste stdin beim Aufruf aus Programmen explizit auf /dev/null umgeleitet werden, sonst hing der Prozess. Ab v4.10.1 ist das nicht mehr nötig.

Weitere Befehle

Eine vollständige Liste aller verfügbaren Befehle finden Sie im Kapitel Engine-Befehle.

Für die Studio-Steuerung via MCP siehe Studio-Befehle.

Für AI-Skill-Verwaltung siehe AI-Skills.

Für fortgeschrittene Workflows mit Befehlsverkettung siehe Template-Pipes.

InstallationShell-Completion