Kommandozeile¶

gview-gview-pipe ist ein Kommandozeilen-Client der REST API für Skripte und CI-Pipelines: Workflows aus Dateien bereitstellen, Läufe starten und auf sie warten, Ausführungen ansehen.

Installieren¶

dotnet tool install --global gView.Pipe.Cli
gview-pipe --help

Das geht, sobald das Paket auf NuGet veröffentlicht ist. Bis dahin baust du es aus dem Quellcode und installierst es aus dem Ordner:

dotnet pack src/gView.Pipe.Cli -c Release -o artifacts/cli
dotnet tool install --global gView.Pipe.Cli --add-source artifacts/cli

Nach einer Änderung packst du neu und rufst dotnet tool update --global gView.Pipe.Cli --add-source artifacts/cli auf (erhöhe vorher die Version in Directory.Build.props, sonst wird das zwischengespeicherte Paket verwendet). dotnet tool uninstall --global gView.Pipe.Cli entfernt es.

Es braucht die .NET-10-Runtime und einen API-Schlüssel mit den Rechten für das, was du tust (read, run, deploy).

Verbinden¶

Setze die Adresse des Servers und den Schlüssel als Umgebungsvariablen, damit der Schlüssel weder in der Prozessliste noch in den Logs der Pipeline erscheint:

bashPowerShell

export PIPE_URL=https://pipe.example.com
export PIPE_API_KEY=pipe_...

$env:PIPE_URL = "https://pipe.example.com"
$env:PIPE_API_KEY = "pipe_..."

--url und --key tun dasselbe für einen Aufruf.

Befehle¶

Befehl	Tut
`gview-pipe workflows list [--json]`	Listet die Workflows.
`gview-pipe workflows get <id>`	Gibt den Workflow als JSON aus.
`gview-pipe workflows export <id> --out <Datei oder Ordner>`	Speichert den Workflow als Datei; bei einem Ordner heißt sie `<id>.json`.
`gview-pipe workflows deploy <Datei oder Ordner>... [--dry-run] [--force]`	Legt Workflows aus JSON-Dateien an oder ersetzt sie (Ordner: alle `*.json` darunter).
`gview-pipe workflows delete <id>`	Löscht einen Workflow.
`gview-pipe workflows activate <id>`, `deactivate <id>`	Schaltet seine Trigger ein oder aus.
`gview-pipe run <id> [--wait] [--input <Datei oder ->] [--environment <Name>] [--timeout <Sekunden>] [--json]`	Startet einen Lauf.
`gview-pipe executions list [--workflow <id>] [--status <Status>] [--limit <n>] [--json]`	Listet Ausführungen, neueste zuerst.
`gview-pipe executions get <workflowId> <id>`	Eine Ausführung mit ihren Node-Läufen.
`gview-pipe executions cancel <workflowId> <id>`	Stoppt einen laufenden oder wartenden Lauf.
`gview-pipe executions replay <workflowId> <id> [--from <nodeId>]`	Führt eine Ausführung erneut aus.

Bereitstellen¶

gview-pipe workflows deploy workflows/            # jede *.json unter dem Ordner
gview-pipe workflows deploy hello-pipe.json --dry-run

Die Datei ist das JSON eines Workflows, wie es gview-pipe workflows export schreibt oder wie es in data/workflows liegt; die id darin benennt den Workflow. Der Server prüft ihn vor dem Speichern; Probleme werden aufgelistet, und der Exit-Code ist 2.

Ein vorhandener Workflow wird nur ersetzt, wenn ihn seit dem Lesen durch den Befehl niemand geändert hat, zum Beispiel im Editor. Sonst bricht der Befehl mit einer Meldung ab; --force ersetzt ihn trotzdem.
--dry-run meldet nur would create oder would update. Er prüft den Workflow nicht; das macht der Server beim echten Deploy.
deploy löscht nie. Entferne Workflows einzeln mit gview-pipe workflows delete.
Credentials, die es auf dem Server nicht gibt, werden als Warnungen gemeldet.

Ausführen¶

gview-pipe run hello-pipe                                   # startet ihn, gibt die Execution-Id aus
gview-pipe run hello-pipe --wait --input item.json          # wartet und gibt die Items des letzten Nodes aus
echo '{ "name": "Ada" }' | gview-pipe run hello-pipe --wait --input -

--input ist ein JSON-Objekt (ein Item) oder ein Array von Objekten; - liest es von der Standardeingabe. Der Lauf startet wie ein getriggerter Lauf, siehe Einen Workflow ausführen.

Exit-Codes¶

Code	Bedeutung
0	Erledigt. Ohne `--wait` gilt ein gestarteter Lauf als erledigt.
1	`gview-pipe run --wait`: Der Lauf endete mit dem Status `error`.
2	Falscher Aufruf, oder der Server hat ihn abgelehnt (`401` Schlüssel, `404`, `422` ungültiger Workflow, `429` Warteschlange voll).

Ein Pipeline-Schritt kann den Befehl deshalb direkt verwenden: Ein fehlgeschlagener Lauf oder ein abgelehntes Deploy lässt den Schritt fehlschlagen.

# Beispiel: GitHub Actions
- run: dotnet tool install --global gView.Pipe.Cli
- run: gview-pipe workflows deploy workflows/
  env:
    PIPE_URL: ${{ vars.PIPE_URL }}
    PIPE_API_KEY: ${{ secrets.PIPE_API_KEY }}