Befehle
Übersicht aller verfügbaren CLI-Befehle. Jeder Befehl hat eine eigene Detailseite mit Syntax, Optionen und Beispielen.
Befehlsübersicht
| Befehl | Alias | Beschreibung |
|---|---|---|
login | - | Beginnt oder erneuert eine Session mit einer Engine |
logout | - | Beendet die aktuelle Session |
session-status | st | Zeigt den Status der aktuellen Session |
deploy-files | deploy | Transportiert BPMN-Diagramme auf die Engine |
remove-process-models | remove | Entfernt Prozessmodelle von der Engine |
start-process-model | start | Startet eine neue Prozessinstanz |
stop-process-instance | stop | Stoppt laufende Prozessinstanzen |
list-process-models | lsp | Listet, sortiert und filtert Prozessmodelle |
list-process-instances | lsi | Listet, sortiert und filtert Prozessinstanzen |
show-process-instance | show | Zeigt Details zu einzelnen Prozessinstanzen |
list-correlations | lsc | Listet Correlations auf |
retry-process-instance | retry | Startet fehlgeschlagene Prozessinstanzen neu |
install-extension | install | Installiert Extensions |
Allgemeine Optionen
Alle Befehle unterstützen folgende Optionen:
| Option | Beschreibung |
|---|---|
--help, -h | Zeigt die Hilfe für den Befehl an |
--version | Zeigt die installierte Version der CLI |
--output, -o | Steuert das Ausgabeformat: text oder json (Standard: text) |
JSON-Output für Automatisierung
Für Skripte und Automatisierung verwenden Sie das JSON-Ausgabeformat:
# Output in Variable speichern
MODELS=$(pc list-process-models --output json)
# Mit jq verarbeiten
pc list-process-models --output json | jq '.result[] | .name'Piping
Befehle können über den Pipe-Operator (|) miteinander verkettet werden. Details finden Sie im Kapitel Template-Pipes.
# Fehlgeschlagene Instanzen erneut versuchen
pc list-process-instances --filter-by-state error | pc retry-process-instance
# Deployen und direkt starten
pc deploy-files process.bpmn | pc start-process-model {{.processModelId}}