Skip to Content
DocsDevopsCLIBefehle

Befehle

Übersicht aller verfügbaren ProcessCube® CLI Befehle.

Session Management

login

Beginnt oder erneuert eine Session mit einer Engine.

pc login <engineUrl> [options]

Argumente:

  • engineUrl - URL der zu verbindenden Engine

Optionen:

  • --m2m-client-id - Client ID für Machine-to-Machine-Autorisierung
  • --m2m-client-secret - Client Secret für Machine-to-Machine-Autorisierung
  • --m2m-scope - Scopes für Machine-to-Machine-Autorisierung
  • --root - Nutzt anonymen Root-Zugriff
  • --root-access-token - Nutzt gegebenen Root Access Token
  • --output, -o - Ausgabeformat: text oder json (Standard: text)

Beispiele:

# Login per Browser
pc login http://localhost:56000
 
# Login per M2M
pc login http://localhost:56000 --m2m-client-id $CLIENT_ID --m2m-client-secret $CLIENT_SECRET
 
# Login per Root-Zugang (nur Development)
pc login http://localhost:56000 --root

Der --root Parameter sollte nur für Development-Umgebungen verwendet werden!

logout

Beendet die aktuelle Session.

pc logout

session-status

Zeigt Informationen über die aktuelle Session an.

pc session-status [options]

Optionen:

  • --output, -o - Ausgabeformat: text oder json (Standard: text)

Prozessmodell-Verwaltung

list-process-models

Listet alle verfügbaren Prozessmodelle auf.

pc list-process-models [options]

Optionen:

  • --output, -o - Ausgabeformat: text oder json (Standard: text)

Beispiel:

pc list-process-models

deploy-files

Transportiert ein oder mehrere BPMN-Diagramme auf die verbundene Engine.

pc deploy-files [filenames...] [options]
pc deploy [filenames...] [options]

Argumente:

  • filenames - Dateinamen der zu transportierenden Diagramme

Optionen:

  • --output, -o - Ausgabeformat: text oder json (Standard: text)

Beispiele:

# Einzelne Datei deployen
pc deploy-files process.bpmn
 
# Mehrere Dateien deployen
pc deploy-files process1.bpmn process2.bpmn
 
# Alle BPMN-Dateien deployen
pc deploy-files *.bpmn
 
# Mit Glob-Pattern
pc deploy-files ./diagrams/**/*.bpmn

remove-process-models

Entfernt ein oder mehrere Prozessmodelle von der Engine.

pc remove-process-models <processModelIds...> [options]

Argumente:

  • processModelIds - IDs der zu entfernenden Prozessmodelle

Optionen:

  • --output, -o - Ausgabeformat: text oder json (Standard: text)

Beispiel:

pc remove-process-models my_process another_process

Prozessinstanz-Verwaltung

list-process-instances

Listet Prozessinstanzen auf.

pc list-process-instances [options]

Optionen:

  • --process-model <id> - Filtert nach Prozessmodell-ID
  • --output, -o - Ausgabeformat: text oder json (Standard: text)

Beispiele:

# Alle Instanzen auflisten
pc list-process-instances
 
# Instanzen eines bestimmten Prozesses
pc list-process-instances --process-model my_process

start-process-model

Startet eine neue Prozessinstanz.

pc start-process-model <processModelId> [options]

Argumente:

  • processModelId - ID des zu startenden Prozessmodells

Optionen:

  • --payload <json> - Payload für die Prozessinstanz als JSON
  • --start-event <id> - ID des Start-Events (optional)
  • --output, -o - Ausgabeformat: text oder json (Standard: text)

Beispiele:

# Einfacher Start
pc start-process-model my_process
 
# Mit Payload
pc start-process-model my_process --payload '{"orderId": "12345", "amount": 100}'
 
# Mit spezifischem Start-Event
pc start-process-model my_process --start-event StartEvent_Payment

stop-process-instance

Stoppt eine laufende Prozessinstanz.

pc stop-process-instance <processInstanceId> [options]

Argumente:

  • processInstanceId - ID der zu stoppenden Prozessinstanz

Optionen:

  • --output, -o - Ausgabeformat: text oder json (Standard: text)

Beispiel:

pc stop-process-instance abc123def456

retry-process-instance

Versucht eine fehlgeschlagene Prozessinstanz erneut auszuführen.

pc retry-process-instance <processInstanceId> [options]

Argumente:

  • processInstanceId - ID der erneut auszuführenden Prozessinstanz

Optionen:

  • --output, -o - Ausgabeformat: text oder json (Standard: text)

Beispiel:

pc retry-process-instance abc123def456

Extension-Verwaltung

install-extension

Installiert eine Extension für 5Minds Produkte (Engine, Studio, Authority).

pc install-extension <extensionName> [options]

Argumente:

  • extensionName - Name der zu installierenden Extension

Optionen:

  • --version <version> - Spezifische Version installieren
  • --output, -o - Ausgabeformat: text oder json (Standard: text)

Beispiel:

# Neueste Version installieren
pc install-extension monitoring-extension
 
# Spezifische Version installieren
pc install-extension monitoring-extension --version 1.2.3

Hilfe

—help

Zeigt Hilfe für die CLI oder einen spezifischen Befehl an.

# Allgemeine Hilfe
pc --help
 
# Hilfe für einen bestimmten Befehl
pc login --help
pc deploy-files --help

—version

Zeigt die installierte Version der CLI an.

pc --version

Best Practices

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 '.[] | .name'

Environment Variables

Sensible Daten können über Umgebungsvariablen übergeben werden:

export CLIENT_ID="my-client-id"
export CLIENT_SECRET="my-secret"
 
pc login https://engine.processcube.io \
  --m2m-client-id $CLIENT_ID \
  --m2m-client-secret $CLIENT_SECRET

Glob Patterns

Verwenden Sie Glob-Patterns für effizientes Deployment:

# Alle BPMN-Dateien in allen Unterverzeichnissen
pc deploy-files ./**/*.bpmn
 
# Nur Dateien in einem bestimmten Verzeichnis
pc deploy-files ./production/*.bpmn
 
# Mehrere Patterns
pc deploy-files ./processes/**/*.bpmn ./workflows/**/*.bpmn

Weitere Informationen

Detaillierte Informationen zur Installation und ersten Schritten finden Sie in den folgenden Kapiteln:

CLIErste Schritte