SDK und CLI
Fóir veröffentlicht zwei npm-Pakete: einen typisierten Client für Ihre Anwendung und ein Kommandozeilenwerkzeug für Skripte und CI.
Der typisierte Client
Der typisierte Client in @foir/sdk sendet GraphQL an denselben Endpunkt wie jeder andere Client und schreibt das Dokument für Sie. Ein typisierter Aufruf ist eine Anfrage. Er gibt standardmäßig jedes skalare Feld des Modells zurück, und pick, omit und include passen die Auswahl an.
Seine Typen stammen aus foir types und werden pro Schlüssel generiert, sodass eine Operation, die der Schlüssel nicht ausführen kann, nicht im Typ steht.
Wo der Client läuft
Der Client verwendet nur fetch und hält keinen Zustand auf Modulebene. Die Dokumentation behandelt ihn in Hydrogen, React-Router-Loadern, TanStack Start und Edge-Runtimes. Weitere Einstiegspunkte im selben Paket behandeln Sitzungen für Ihre Nutzer, Live-Updates und Medien.
Was die CLI abdeckt
@foir/cli installiert den Befehl foir. Seine Befehlsgruppen decken Datensätze, Modelle, Locales, Medien, Suche, Rollouts, Releases, den Cache, API-Schlüssel, Ihre Nutzer und deren Rollen, Organisationen, Operationen, Hooks, Zeitpläne, Secrets, Anmeldeanbieter, Export und Typgenerierung ab. Er wendet auch Ihre Config-Datei mit einem Push an. Die CLI-Referenz listet die Befehle auf, und die Intent-Referenz in der Dokumentation zeigt, welche Plattformaktionen einen haben.
Ausgabe und Anmeldung für Skripte
Jeder Befehl gibt standardmäßig eine Tabelle aus und kann JSON, JSON Lines oder nur IDs für das Piping ausgeben. Payloads kommen aus einem Flag, einer Datei oder stdin. Sie melden sich über den Browser an, mit einem Device-Code-Flow für SSH, Container und CI, oder setzen für Headless-Läufe einen API-Schlüssel in der Umgebung.
Details nachlesen
Der SDK-Leitfaden behandelt die Installation des typisierten Clients, die Generierung seiner Typen und das Absetzen von Aufrufen, und die CLI hat eine eigene Referenz.