ephemeral ist ein Kommandozeilen-Client für die Engine-API. Er startet und verfolgt Ausführungen, verwaltet Dateien, Workflows und Verbindungen und akzeptiert Definitionen in JSON oder YAML.
Installieren
macOS und Linux:
curl -fsSL https://ephemer.al/install.sh | shWindows (PowerShell 5.1 oder neuer):
irm https://ephemer.al/install.ps1 | iexDas Installationsprogramm lädt die neueste Version für Ihr System von github.com/erni-works/ephemeral-cli herunter, prüft sie anhand der signierten Prüfsummen des Releases und installiert sie ohne Administratorrechte: ~/.local/bin/ephemeral unter macOS und Linux, %LOCALAPPDATA%\Programs\ephemeral\bin unter Windows. Setzen Sie EPHEMERAL_VERSION=v1.2.3, um eine bestimmte Version zu installieren, oder EPHEMERAL_INSTALL_DIR, um das Verzeichnis zu wählen. Es gibt Builds für macOS, Linux und Windows auf x86-64 und ARM64.
ephemeral version
ephemeral update # install the latest release
ephemeral update --check # only report whether one is availableephemeral update prüft Signatur und Prüfsumme des Releases, bevor es sich selbst ersetzt. Einmal täglich prüfen interaktive Befehle außerdem, ob eine neuere Version vorliegt, und geben einen einzeiligen Hinweis aus; mit EPHEMERAL_NO_UPDATE_CHECK=1 schalten Sie das ab. In CI wird der Hinweis nie angezeigt.
Anmelden
Erstellen Sie im Dashboard unter API-Schlüssel einen API-Schlüssel und speichern Sie ihn dann. login prüft den Schlüssel, bevor es ihn in Ihrem Benutzer-Konfigurationsverzeichnis ablegt, lesbar nur für Sie.
ephemeral login # paste the key; it is not shown
ephemeral login --url https://ephemeral.example.com # a self-hosted installation
ephemeral status| Variable | Zweck |
|---|---|
EPHEMERAL_ | Basis-URL der Engine, ohne /v1. Überschreibt die gespeicherte URL; Standard ist https://app.ephemer.al. |
EPHEMERAL_ | Der API-Schlüssel, der als Bearer-Token gesendet wird. Überschreibt den gespeicherten Schlüssel, der nur an die URL gesendet wird, für die er gespeichert wurde. |
EPHEMERAL_ | Optional. Wird als X-Ephemeral-Organization gesendet, um eine Organisation zu wählen, wenn das Token eine Benutzersitzung ist. |
ephemeral status ruft GET /v1/me auf und gibt Organisation, Rolle und Budgeteinstellungen aus, was eine schnelle Möglichkeit ist, die Konfiguration zu prüfen. Die Ausgabe ist JSON, sofern nicht anders angegeben.
Ausführungen
# Inline-Prompt, mit einer lokalen Datei, die hochgeladen und eingebunden wird
ephemeral run --prompt "Summarize the supplied instructions." \
--file ./instructions.md --input '{"customer_id":"customer_123"}' --wait
# Ein gespeicherter Workflow
ephemeral run --workflow investigate-payment --input '{"payment_id":"pay_123"}' --max-cost-micros 500000
# Eine vollständige Definition aus einer Datei
ephemeral run run.yaml --wait| Option | Wirkung |
|---|---|
FILE | Eine Ausführungsdefinition in JSON oder YAML. Flags ersetzen die entsprechenden Felder, und --file ergänzt ihre Dateien. |
--prompt TEXT | Inline-Prompt. Nicht mit --workflow kombinierbar. |
--workflow NAME | Einen gespeicherten Workflow starten. |
--input JSON | Eingabe der Ausführung. Muss gültiges JSON sein. |
--file PATH | Eine lokale Datei hochladen und unter ihrem Basisnamen einbinden. Für mehrere Dateien wiederholen. |
--max-cost-micros N | Das Budget der Ausführung. |
--idempotency-key KEY | Der Idempotency-Key für das Erstellen der Ausführung, bis zu 200 Zeichen. Ohne Angabe wird ein zufälliger Schlüssel verwendet. |
--wait | Jede Sekunde abfragen und die finale Ausführung ausgeben. Beendet sich mit einem Wert ungleich null, wenn die Ausführung nicht erfolgreich war. |
Schlägt das Erstellen der Ausführung mit einem Netzwerkfehler oder einer 5xx-Antwort fehl, wiederholt die CLI es bis zu dreimal mit demselben Idempotenzschlüssel. Eine Anfrage, die die Engine erreicht hat, liefert dann die ursprüngliche Ausführung zurück, statt eine zweite zu starten. Schlagen alle Versuche fehl, gibt der Fehler den Schlüssel aus; führen Sie den Befehl erneut mit --idempotency-key und diesem Schlüssel aus, um eine doppelte Ausführung zu vermeiden.
Drücken Sie beim Warten Strg+C, hört die CLI auf zu warten. Die Ausführung läuft weiter; prüfen Sie sie später mit ephemeral runs get ID.
ephemeral runs list --limit 20 --status succeeded
ephemeral runs get run_4abb0f420c6623a12d2889610eb67284
ephemeral runs events run_4abb0f420c6623a12d2889610eb67284
ephemeral runs cancel run_4abb0f420c6623a12d2889610eb67284
ephemeral runs definition run_4abb0f420c6623a12d2889610eb67284runs events gibt den rohen Ereignis-Stream aus, sobald er eintrifft, einschließlich Ereignis-IDs und -Namen. runs cancel gibt eine Bestätigungszeile aus.
Dateien
ephemeral files upload instructions.md --name guides/instructions.md
ephemeral files list
ephemeral files download file_9c41d2a07be35f1e8a6c0d4b9e2f7a13 > instructions.md
ephemeral files rename file_9c41d2a07be35f1e8a6c0d4b9e2f7a13 playbook.md
ephemeral files delete file_9c41d2a07be35f1e8a6c0d4b9e2f7a13Workflows und Verbindungen
ephemeral workflows save investigate-payment workflow.yaml
ephemeral workflows list
ephemeral workflows get investigate-payment
ephemeral workflows delete investigate-payment
ephemeral connections catalog
ephemeral connections save payments-api connection.yaml
ephemeral connections list
ephemeral connections get payments-api
ephemeral connections delete payments-api
ephemeral oauth connect payments-apitype: http
url: https://api.example.com/v2
auth:
type: bearer
token: sk_live_…
allowed_methods: [GET]save gibt eine Bestätigung aus und zeigt die Definition nie wieder an. get und list ersetzen Zugangsdatenfelder durch [redacted]. Zum Speichern und Lesen von Verbindungen ist ein Admin-Schlüssel nötig; connections catalog funktioniert mit jedem Schlüssel. oauth connect gibt die Autorisierungs-URL aus und öffnet sie in Ihrem Browser; mit --no-browser wird sie nur ausgegeben.
Zeitpläne
ephemeral schedules preview "0 9 * * 1-5" Asia/Tokyo
ephemeral schedules create schedule.yaml
ephemeral schedules list --workflow welcome-new-customers
ephemeral schedules run sch_4f9c…
ephemeral schedules pause sch_4f9c…
ephemeral schedules resume sch_4f9c…
ephemeral schedules update sch_4f9c… changes.yaml
ephemeral schedules delete sch_4f9c…workflow: welcome-new-customers
name: Weekday welcome emails
cron: "0 9 * * 1-5"
timezone: Asia/Tokyo
input:
signed_up: yesterday
max_cost_micros: 200000preview prüft einen Fahrplan und gibt seine nächsten fünf Startzeiten aus, ohne etwas zu speichern. update ändert nur die Felder in der Datei. Zum Erstellen, Ändern und Löschen von Zeitplänen ist ein Admin-Schlüssel nötig. Siehe Zeitpläne.
Weitere Befehle
| Befehl | Funktion |
|---|---|
ephemeral models | Gibt den Modellkatalog aus. |
ephemeral api METHOD / | Sendet eine beliebige Anfrage an die API unter EPHEMERAL_URL, mit optionalem JSON- oder YAML-Body. |
ephemeral keys list|create NAME [admin|member]|revoke ID | Verwaltet API-Schlüssel einer selbst gehosteten Installation. Beim gehosteten Dienst nicht verfügbar. |
ephemeral help | Gibt die vollständige Befehlsliste aus. |
Die operator-Befehle in der Hilfeausgabe sind für Ephemeral-Mitarbeitende gedacht und erfordern private Dienst-Zugangsdaten. Schlägt ein Befehl fehl, gibt die CLI den HTTP-Status aus, meist mit der Fehlermeldung der API, und beendet sich mit Status 1.