CLI & Tooling
Eine laufende App
Diese Befehle kommunizieren über ihre eigene API mit einer laufenden App, sodass Row-Level Security, Feldzugriff, Hooks und Storage-Policies darüber entscheiden, was sie tun dürfen, genau wie beim SDK. Sie erreichen das lokale rebase dev, einen angegebenen Server oder ein Rebase Cloud-Projekt – überall mit denselben Flags.
Server und Anmeldedaten auswählen
Abschnitt betitelt „Server und Anmeldedaten auswählen“| Flag | Wohin Anfragen gesendet werden und als wer |
|---|---|
| (keine) | REBASE_BASE_URL (Shell, dann .env), andernfalls das rebase dev, das dieser Checkout ausführt; mit dem Service-Key aus .env |
--url <server> |
Dieser Server, mit dem Service-Key aus .env |
--project <slug> |
Ein Rebase Cloud-Projekt über den Studio-Proxy der Konsole: Sie melden sich mit rebase cloud login an, und die Control-Plane hängt den App-Key auf ihrer Seite an, sodass kein Key Ihren Rechner erreicht. Organisationsinhaber und Administratoren bei einem Projekt, dessen Studio-Zugriff aktiviert ist (rebase cloud settings set --studio on) |
--cloud |
Das Rebase Cloud-Projekt, mit dem dieses Verzeichnis verknüpft ist |
--token <bearer> |
Stattdessen diesen Bearer senden: ein rk_-Key oder das Zugriffstoken eines Benutzers. Bei einem Cloud-Projekt geht dies an die eigene Adresse der App |
--session |
Die Benutzersitzung senden, die rebase auth login für diesen Server gespeichert hat |
--anon |
Nichts senden: was ein Besucher erhält |
Es wird nichts anderes erraten: Ohne REBASE_BASE_URL und ohne laufendes rebase dev verweigert ein Befehl die Ausführung, anstatt den Service-Key an irgendeinen Port zu senden, der gerade lauscht. Jeder Befehl akzeptiert --json (und gibt JSON aus, wann immer stdout kein Terminal ist, wie auch rebase cloud) und --yes, was die Bestätigung beantwortet, die jeder destruktive Befehl verlangt; ohne Terminal bricht er mit confirmation_required ab, statt nachzufragen.
rebase api-keys, rebase storage orphans|move und rebase schema reconcile akzeptieren dieselben Flags.
rebase api
Abschnitt betitelt „rebase api“Jede Route, die die App bereitstellt, mit den Anmeldedaten des Projekts – der Long Tail, der keinen eigenen Befehl hat: der Refresh einer Materialized View, das RLS-Audit, /api/meta/contract, eine von einem Plugin hinzugefügte Route.
rebase api data/posts -f status=eq.published -f limit=5 # GET /api/data/posts?status=eq.published&limit=5rebase api POST data/posts -F title=Hello -F published=truerebase api /api/admin/rls-audit --project acmerebase api PATCH data/posts/42 --input change.json --includeEin Pfad ohne führenden / liegt unter /api. -f key=value ist ein String-Feld und -F ein typisiertes (true, false, null, Zahlen, JSON, @file); Felder bilden den Query-String bei einem GET, HEAD oder DELETE und andernfalls einen JSON-Body. Anders als bei gh api macht ein Feld allein die Anfrage niemals zu einem POST: Eine Schreiboperation gibt ihre Methode an oder enthält --input. Die Antwort wird so ausgegeben, wie sie empfangen wurde – JSON formatiert (pretty-printed) – und eine Nicht-2xx-Antwort wird ausgegeben und beendet den Prozess mit Exit-Code 1. Ein Authorization-Header wird abgelehnt; die Ziel-Flags bestimmen die Anmeldedaten.
rebase data
Abschnitt betitelt „rebase data“Die Zeilen einer Tabelle über /api/data. Filter entsprechen denen der API (?status=eq.published) und werden wie geschrieben weitergegeben: --where status=eq.published, --where price=gte.10 und ein einfaches --where status=draft für Gleichheit.
rebase data query posts --where status=eq.published --order-by created_at:desc -n 10rebase data query orders --all --format csv > orders.csvrebase data get posts 42 --include authorrebase data count posts --where status=eq.draftrebase data aggregate orders --select "count(),sum(total)" --group-by statusrebase data insert posts --data '{"title":"Hello"}'rebase data update posts 42 --data '{"title":"Renamed"}'rebase data delete posts --where status=eq.draft --yesrebase data import posts --file seed.csv --upsert slugrebase data history posts 42 && rebase data revert posts 42 <historyId>rebase data watch posts --where status=eq.published| Aktion | Hinweise |
|---|---|
query <table> |
--where, --or, --order-by col[:desc] (wiederholbar), --limit, --offset, --fields a,b, --include, --search, --deleted include|only; --all durchläuft jede Seite; --format table|json|ndjson|csv (CSV und NDJSON streamen bei --all) |
get <table> <id> |
Eine Zeile, mit --fields und --include |
count <table> |
Die Zeilen, die auf --where zutreffen |
aggregate <table> |
--select und --group-by, wie in der API |
insert <table> |
--data <json> oder --file <path|->; ein Array entspricht mehreren Zeilen in einem Bulk-Schreibvorgang; --upsert <column> |
update <table> [<id>] |
Eine Zeile oder jede Zeile, auf die --where zutrifft, nach einer Zählung und Bestätigung; --if-match <etag> |
delete <table> [<id>] |
Fragt zuerst nach; --hard bei einer Tabelle mit Soft-Delete |
import <table> |
--file (JSON-Array, NDJSON oder CSV anhand der Dateiendung oder --format), in Batches (--batch); --upsert, --ignore-duplicates. Liest ein, was query --format json ausgibt |
history <table> <id>, revert <table> <id> <historyId> |
Tabellen mit aktivierter Historie |
watch <table> |
Die passenden Zeilen bei jeder Änderung über den Realtime-Socket. Nicht über den Studio-Proxy: Bei einem Cloud-Projekt --token oder --session übergeben |
Der Service-Key entspricht der admin-Rolle: Row-Level Security wird weiterhin ausgeführt, und zwar als diese Rolle. Übergeben Sie --token, --session oder --anon, um die Tabelle aus der Sicht von jemand anderem zu sehen.
rebase schema show
Abschnitt betitelt „rebase schema show“Die Tabellen oder die Spalten, Relationen und Row-Level Security einer einzelnen Tabelle – standardmäßig aus backend/schema oder mit --remote (oder einem beliebigen Ziel-Flag), so wie der laufende Server sie für diese Anmeldedaten beschreibt. Anmeldedaten ohne schema:read sehen keine Policies, und eine Tabelle, die nicht gelesen werden kann, wird nicht aufgeführt.
rebase schema showrebase schema show posts --remote --project acmerebase users
Abschnitt betitelt „rebase users“Die Benutzerkonten über /api/admin/users, /roles und /guests. Ein Konto wird über seine UID oder E-Mail-Adresse angegeben (eine exakte Übereinstimmung, niemals der erste unscharfe Treffer).
rebase users list --search adarebase users create ada@example.com --role adminrebase users update bob@example.com --add-role editorrebase users update bob@example.com --disablerebase users reset-password bob@example.comrebase users mfa-reset bob@example.comrebase users rolesrebase users guests prune --older-than 30d --yescreate versendet eine Einladung per E-Mail oder gibt einmalig ein temporäres Passwort zurück, wenn keine E-Mail gesendet werden kann. --no-invite erstellt das Konto ohne Passwort und sendet nichts – für Apps, bei denen die Anmeldung über Magic-Links, E-Mail-Codes oder externe Anbieter erfolgt (POST /api/admin/users mit invite: false). Das Zuweisen einer Rolle, --disable, delete und mfa-reset fragen vorher nach. Kein Aufrufer darf eine Rolle vergeben, die über der eigenen steht, oder Aktionen für ein höherrangiges Konto durchführen. rebase auth reset-password ist die ältere Schreibweise und greift weiterhin auf die Datenbank zurück, wenn der Server nicht läuft.
rebase cron
Abschnitt betitelt „rebase cron“Die geplanten Jobs der App (backend/crons/*).
rebase cron listrebase cron logs nightly-backup -n 5rebase cron run cleanup-sessions --yesrebase cron disable nightly-backup --yesrebase cron reset nightly-backup # the job's code decides againenable und disable überschreiben den Code des Jobs in jedem Prozess über erneute Deployments hinweg; run fragt vorher nach, und --async antwortet, sobald die Ausführung gestartet wurde. Bei einem Cloud-Projekt benötigt rebase cron für Lesezugriffe keinen Studio-Zugriff: Es fordert von der Control-Plane ein kurzlebiges cron:read-Plattform-Token an, über das jedes Mitglied mit Log-Zugriff verfügt. run, enable, disable und reset erfordern cron:write, worüber ein Organisationsinhaber oder -administrator bei einem Projekt mit aktiviertem Studio verfügt. rebase cloud cron ist die ältere, schreibgeschützte Schreibweise.
rebase logs
Abschnitt betitelt „rebase logs“Das Request- und Anwendungsprotokoll des Servers – der Puffer, den der Studio Logs Explorer liest – einmalig oder fortlaufend mit -f.
rebase logs -n 50 --level warnrebase logs -f --source auth --search "sign-in"Der Puffer gehört zu einem einzelnen Prozess. Mit --project oder --cloud entspricht dies rebase cloud logs --runtime: die Ausgabe aller Replikate über die Control-Plane.
rebase functions
Abschnitt betitelt „rebase functions“Die eigenen Routen der App, eine pro Datei in backend/functions/.
rebase functions listrebase functions invoke hello --anonrebase functions invoke billing webhook -X POST --input event.jsoninvoke akzeptiert dieselben Felder, denselben Body und dieselben Header wie rebase api und gibt die Antwort so aus, wie sie empfangen wurde. Funktionen bestimmen ihren Zugriff selbst, daher spielen die Anmeldedaten eine Rolle: --anon zeigt, was ein Besucher erhält.
rebase storage
Abschnitt betitelt „rebase storage“Gespeicherte Dateien über die Storage-Policies. Die Speicherseite beginnt mit einem Doppelpunkt: :avatars/me.png in der Standardquelle, media:avatars/me.png in der mit media benannten Quelle.
rebase storage ls :avatarsrebase storage cp ./me.png :avatars/me.pngrebase storage cp :avatars/me.png ./me.pngrebase storage url :avatars/me.png # a signed link: whoever holds it reads the file until it expiresrebase storage stat :avatars/me.pngrebase storage rm :avatars/me.png --yescp --public lädt unter dem öffentlichen Präfix hoch (eine permanente URL ohne Token), --content-type legt den Typ fest und --force überschreibt beim Herunterladen eine lokale Datei. orphans und move bilden den Teil der Befehlsgruppe für die Wartung des gesamten Speichers.
rebase rls simulate
Abschnitt betitelt „rebase rls simulate“Was eine andere Identität sehen würde, über den RLS-Simulator der App – denselben, den auch Studios „Anzeigen als“ verwendet: pro Tabelle die Zeilen, die sie liest, im Vergleich zu den Zeilen, die Sie lesen, die Tabellen, von denen sie durch ihre Scopes ausgeschlossen ist, und die Spalten, die sie nicht lesen kann. Schreibgeschützt.
rebase auth login --email you@example.comrebase rls simulate --role anonrebase rls simulate --user 3f0c9a7e-… --table postsrebase rls simulate --key <api-key-id>rebase rls optionsDer Simulator reagiert nur auf die Sitzung eines Administrators und niemals auf einen Key; daher wird hier die Sitzung gesendet, die rebase auth login gespeichert hat. rebase verify --live prüft die Policies selbst, ohne eine bestimmte Identität zu berücksichtigen.
rebase auth login, emails und keys
Abschnitt betitelt „rebase auth login, emails und keys“Manche Routen antworten nur Personen und niemals Maschinen: der RLS-Simulator, persönliche Keys, die Anwendung von Live-Schemas. rebase auth login meldet Sie bei einer laufenden App an – über den Browser, wenn der Server Geräteanmeldung unterstützt, andernfalls mit --email und einem Passwort (--code für einen zweiten Faktor) – und speichert die Sitzung in ~/.rebase/sessions.json, aufgeschlüsselt nach Server, niemals im Projekt. auth whoami gibt an, als wer der Server Sie einstuft und welche Scopes Sie besitzen; auth logout beendet die Sitzung auch dort.
rebase auth login --email you@example.comrebase auth whoami --sessionrebase auth emails --latest --links # the dev mailbox: sign-in, reset and magic-link mail with no SMTP_HOSTrebase auth keys create --name ci --scopes data:read:posts --expires-in 30rebase auth keys revoke <id> --yesauth emails liest das Entwicklungs-Postfach aus, das ein Server ohne SMTP_HOST anstelle des Versands führt; --clear leert es. auth keys verwaltet Ihre eigenen rk_-Keys, die in Ihrem Namen agieren, beschränkt auf die angegebenen Scopes; der Server antwortet darauf nur, wenn in der Auth-Tabelle auth.personalKeys: true konfiguriert ist. Service-Keys werden über rebase api-keys verwaltet, was ebenfalls um update <id> erweitert wurde.
Nächste Schritte
Abschnitt betitelt „Nächste Schritte“- Endpunkt-Index — jede Route, die diese Befehle erreichen, und die jeweils erforderlichen Scopes
- REST-API — die Filter-, Sortier- und Paginierungssyntax, die
rebase dataweiterreicht - rebase cloud — das Projekt selbst auf Rebase Cloud: Deployments, Umgebung, Backups, Studio-Zugriff
- CLI-Referenz — alle anderen Befehle