Projekte: CLI-Befehle

Den Projektdatensatz lesen.

project show

Keine Parameter.

screenrig project show

Legen Sie den Namen fest, den Personen im Dashboard-Projektumschalter sehen.

project rename NAME

Die Projekte ersetzen, die das Token dieser Anmeldung abdeckt.

project token --projects IDS

screenrig project token --projects prj_01EXAMPLEPROJECT0000,prj_01EXAMPLEOTHER000000

Ersetzt die gesamte Teilmenge; project list allein gewährt keinen Zugriff. Eine verlorene Antwort behält die Rotationsanfrage-ID für eine identische Wiederholung.

Lese den Plan des Projekts, unabhängige screens und advertiser Feature-Flags sowie den effektiven Funktionsumfang. Eine Routenverweigerung hat Vorrang vor einer veralteten Funktionslesung.

project capabilities

Lese die tägliche Bildschirmverfügbarkeit des Projekts über UTC-Tage.

project uptime [--day-from YYYY-MM-DD] [--day-to YYYY-MM-DD] [--format json|csv|xlsx|pdf] [--output FILE]

screenrig project uptime
screenrig project uptime --day-from 2026-09-01 --day-to 2026-09-30

Bereich und Standardwerte entsprechen denen von screen uptime. data.items listet eine Zeile pro UTC-Tag, älteste zuerst: online_s und offline_s summiert über die Bildschirme mit an diesem Tag aufgezeichnetem Status, availability, coverage (der Anteil der Tageszeit dieser Bildschirme mit aufgezeichnetem Status) und screens (wie viele einen Status hatten). Die heutige Zeile umfasst bisher beendete Intervalle; screen list zeigt, wer jetzt online ist.

Lese den Gesundheitszustand der Flotte nach UTC-Stunden: meldende Bildschirme, heiß, Display getrennt, Abstürze.

project health-trend [--from TIME] [--to TIME] [--format json|csv|xlsx|pdf] [--output FILE]

screenrig project health-trend
screenrig project health-trend --from 7d

data.items listet den Zustand der Flotte nach UTC-Stunden: hour, screens_reporting, hot (Spitzentemperatur bei oder über 80 °C), display_disconnected und crashing (3 oder mehr Abstürze in 24 Stunden). Die CLI folgt next_cursor bis zum Ende und antwortet jede Stunde mit next_cursor null. Stunden folgen Berichten um bis zu etwa 5 Minuten.

Die Daten dieses Projekts in offenen Formaten in ein Verzeichnis schreiben.

project export <DIR> [--no-media] [--since YYYY-MM-DD]

screenrig project export ./export
screenrig project export ./export --no-media --since 2026-01-01

DIR ruft JSON ab für das Projekt, Bildschirme, Bildschirmordner, Tags, Zeitpläne pro Bildschirm, Playlists mit jeder Revision, Kampagnen, Direktkampagnen, Karten und ihre Daten, Datenquellen (nie deren Anmeldeinformationen), Benachrichtigungen, Webhooks (ohne Signatur-Secrets oder Empfänger-URLs), Stummschaltungen, Anwendungsmetadaten, Trigger und Berichtsabonnements; die originalen Mediendateien in media/files, wobei media/manifest.json den SHA-256 jeder Datei enthält; CSV für Wiedergaben, Wiedergabeaufzeichnungen, Betriebszeit und Alarme in data/; und das Ereignisprotokoll in log/events.jsonl. export.json wird zuletzt geschrieben und listet jede Datei mit Größe und SHA-256 sowie das Ergebnis jedes Abschnitts auf (ok, skipped oder failed). Ein erneuter Lauf behält vollständige Mediendateien und setzt unvollständige fort. Ein Abschnitt, den die Anmeldeinformation nicht lesen kann, ist skipped; die Warnung export_section_failed bedeutet, dass die Kopie unvollständig ist, führen Sie also denselben Befehl erneut aus. Anwendungsdateien werden mit complete: false und der Warnung export_application_content_omitted als ausgelassen gemeldet, auch mit --no-media: Bewahren Sie die originalen Anwendungsarchive zur Wiederherstellung auf. Jede Anfrage ist eine abgerechnete API-Anfrage, und Mediendownloads sind Egress.

Erstellen, auflisten oder widerrufen Sie Einladungen für Projektmitglieder, Uploader und Anzeigenkäufer.

invitations create (--email ADDRESS[,ADDRESS] | --link) [--kind member|uploader|ad-buyer]
    [--screen-id IDS] [--screen-folder-id IDS] [--slot-id IDS] [--policy trusted|review_required]
    [--folder-id IDS] [--playlist-id IDS] [--access propose|manage]
invitations list [--kind member|ad-buyer] [--status STATUS]
invitations revoke ID

--kind verwendet standardmäßig member. E-Mail-Zustellung ist Standard und läuft nach sieben Tagen ab. --email akzeptiert durch Kommas getrennte Empfänger, bis zu fünfzig pro Anfrage. --link ist nur für Mitglieder, nennt keinen Empfänger und gibt eine 24-Stunden-Einladungs-URL einmalig zur direkten Übergabe an die vorgesehene Person zurück. Geben Sie diese URL niemals in Protokolle, Notizen oder ein geteiltes Transkript ein. Listen geben sie nie zurück. Pro Organisation dürfen höchstens 50 Einladungen offen sein.

Werbekäufer verwenden nur E-Mail und benötigen einen eigenen Bildschirm- oder Slot-Bereich (oder beides). --screen-id und --slot-id akzeptieren durch Kommas getrennte IDs; --policy wählt trusted oder review_required. Statusfilter sind queued, sent, issued, accepted, revoked, expired und failed.

--kind uploader lädt eine Person ein, die nur in den mit --folder-id angegebenen Medienordnern (mindestens einer) und den mit --playlist-id angegebenen Playlists arbeitet: Sie lädt Medien in diese Ordner hoch und fügt Seiten dieser Playlists hinzu, ersetzt und entfernt sie, sonst nichts. Ihre Änderungen warten auf eine Überprüfung, außer bei --access manage, was nur jemand gewähren darf, der Überprüfungen genehmigen kann. Eine --kind member-Einladung mit --screen-folder-id (jeder Ordner umfasst alle Ordner darin) oder --screen-id beschränkt die annehmende Person auf diese Bildschirme. --folder-id, --playlist-id und --access erfordern --kind uploader, und --slot-id und --policy erfordern --kind ad-buyer. Siehe Authentifizierung.

screenrig invitations create --email teammate@example.com
screenrig invitations create --kind ad-buyer --email buyer@example.com --screen-id scr_LOBBY --policy review_required

Agenten akzeptieren keine Einladungen. Die eingeladene Person öffnet die E-Mail, meldet sich an oder erstellt eine Passkey und akzeptiert im Dashboard. Die Link-Anmeldung überprüft zuerst ihre E-Mail. Das Widerrufen einer akzeptierten Einladung hebt keine Mitgliedschaft auf; verwenden Sie die Käufer-Mitgliedschaftskontrollen, um den Werbezugang zu widerrufen.

Melden, ob diese Installation eine verwendbare Anmeldeinformation enthält.

agent status

Keine Parameter.

screenrig agent status

Nur lesend. Ändert niemals lokalen oder Serverzustand und kostet nichts. Das Ergebnis enthält die Sitzung access, deren effective_access und, wenn die Überprüfungseinstellung des Projekts oder ein Mitglied, das nicht genehmigen kann, sie niedriger hält, access_limited_by (project oder person). Beschränkt das Projekt diesen Agenten auf Bildschirmordner und Bildschirme, listet screen_scope sie auf (folder_ids, jeweils mit allen Ordnern darin, und screen_ids), und person_screen_scope ist der Bereich der für den Agenten verantwortlichen Person; der Agent handelt nur auf den Bildschirmen, die beide erlauben, und beide fehlen bei einem Agenten des gesamten Projekts. Außerhalb des Bereichs antwortet ein Befehl mit outside_screen_scope (Exit 3). Neue Projektnotizen oder zur Überprüfung fällige Notizen fügen die Warnung notes_waiting hinzu.

Die Mitgliedschaft dieses Agenten im aktuellen Projekt widerrufen.

agent disconnect --yes [--allow-lockout]

screenrig agent disconnect --yes

Widerruft nur die Mitgliedschaft im aktuellen Projekt: Die Identität, die anderen Mitgliedschaften, das Projekt und seine Bildschirme bleiben bestehen. Lokale Anmeldeinformationen und Wiederholungsstatus bleiben erhalten, wenn die Antwort mehrdeutig ist, sodass ein erneutes Ausführen sicher ist.

Diese Identität und alle ihre Projektmitgliedschaften widerrufen.

agent revoke-identity --yes

screenrig agent revoke-identity --yes

Ein bestätigter Widerruf löscht die lokalen Anmeldeinformationen und ausstehende Arbeit für jedes zwischengespeicherte Projekt. Ein mehrdeutiger Fehler behält sie bei.

Diese Installation mit einem bestehenden Konto anmelden, mit Zustimmung einer Person im Dashboard, oder als Service-Client.

login [--project ID] [--access read|propose|manage] [--name NAME] [--no-wait] [--resume ID]
login --client-id ID (--client-key-file PATH | --client-secret-file PATH)

screenrig login --access read
screenrig --config ci.json login --client-id scl_01EXAMPLECLIENT0000 --client-key-file ci-key.pem

Gibt die Dashboard-Adresse und einen achtstelligen Code auf stderr aus, wartet dann bis zu 24 Stunden. Die Person prüft, ob der Code übereinstimmt, und drückt einmal Verbinden, ohne dass nach einer Dashboard-Anmeldung in der letzten Stunde eine zweite Passkey-Abfrage erfolgt. Der Umschlag meldet status: signed_in, das Projekt, die Organisation und access. Ein erneutes Ausführen auf einer angemeldeten Installation fügt ein Projekt hinzu oder erhöht von Nur-Lesen oder Vorschlagen auf Verwalten. Ablehnung ist login_denied und Ablauf ist login_expired.

Die Konfiguration eines Service-Clients muss eine eigene Datei sein: Jeder spätere Befehl mit diesem --config meldet sich als der Client an, liest dabei jedes Mal die Schlüssel- oder Secret-Datei und hält das Token im Speicher.

Anmeldung dieser Installation beenden und deren Tokens entfernen.

logout

Keine Parameter.

screenrig logout

Widerruft die Anmeldung auf dem Server, entfernt dann die gespeicherten Tokens und meldet status: signed_out. In der Konfiguration eines Service-Clients entfernt es den gespeicherten Client und lässt dessen Schlüssel- oder Secret-Datei bestehen. Ein Fehler, der den Server möglicherweise nicht erreicht hat, behält sie, sodass ein erneutes Ausführen sicher ist. Führen Sie screenrig login aus, um sich erneut anzumelden.

Öffnen Sie die gewöhnliche Dashboard-URL. Dieser Befehl erstellt keinen Anmeldelink, keine Sitzung und benötigt keine Agenten-Anmeldeinformationen.

dashboard [open]

screenrig dashboard

Das Dashboard zeigt die Projekte der Person nach der Anmeldung an. Die Browser-Projektauswahl ändert nicht das an einen Agenten gebundene Projekt.

Anmelderücksetzungs-E-Mail ohne Agenten-Anmeldeinformationen anfordern.

dashboard reset-sign-in --email ADDRESS

Die Bestätigung verrät nicht, ob die E-Mail eine Anmeldung hat. Die per E-Mail gesendete Zurücksetzung läuft nach einer Stunde ab; die Person erstellt einen neuen Passkey. Die Fertigstellung ersetzt ihre Anmeldeinformationen und widerruft andere Sitzungen. Solange die Inhaberschaft des Projekts aus der Einschreibung noch aussteht, sendet --email mit der ursprünglichen Einschreibungsadresse außerdem eine neue siebentägige Einschreibungseinladung per E-Mail; die Person öffnet sie und nimmt sie mit ihrer Anmeldung an, um die Inhaberschaft zu übernehmen.

Prüfen Sie diese Installation und melden Sie jede Prüfung mit Namen.

doctor [--repair-config]

screenrig doctor

data.checks benennt jede Prüfung und ihren Status (pass, warn oder fail): die Node-Laufzeit, den aufgelösten Konfigurationspfad und dessen Berechtigungen, die gespeicherte Anmeldeinformation und das Ende der Anmeldung, die Steuerungsebene und ihre Service-Routen, die beworbene feedback-Fähigkeit und die optionale Medientoolchain (ffmpeg, ffprobe, encoder_libx264, encoder_libx265, encoder_libwebp, cwebp, filter_hdr_tonemap).

Jede fehlgeschlagene Prüfung lässt doctor mit einem Nicht-Null-Exit enden, ein warn dagegen nicht, lesen Sie also die einzelnen Namen, bevor Sie die Installation als nicht gesund markieren. Eine fehlende Medientoolchain betrifft nur die Befehle, die Medien konvertieren: media upload, media upload-batch, media replace und playlist init.

Drucken Sie die gebündelte CLI-Version und ihren Protokolladapter.

version

Keine Parameter.

screenrig version

Führen Sie dies zuerst in einer Sitzung aus. Ein erfolgreiches Envelope beweist, dass der Launcher die gebündelte CLI aufgelöst hat. --version und -V machen dasselbe von überall in der Befehlszeile.

Die Speicher- und Agentenanfragelimits des Plans lesen.

billing usage

Keine Parameter.

screenrig billing usage

data.stored_bytes ist der genutzte Speicher und data.allowance.storage_bytes das Speicherlimit des Plans; ein Upload darüber hinaus wird mit quota_exceeded abgelehnt. data.allowance.requests_per_hour ist das Stundenlimit für Agentenanfragen (agent_requests_per_hour in der Ausgabe für Menschen). Die in dieser Stunde verbleibenden Anfragen stehen im Header RateLimit jeder gezählten Antwort.

Werbebeträge in US-Dollar lesen: verbleibend, reserviert, verfügbar und auszahlbare Einnahmen.

billing balance

Keine Parameter.

screenrig billing balance

Werbetreibende zahlen per Karte oder x402-Maschinenzahlung, Preise und Einnahmen sind in US-Dollar, und Auszahlungen beginnen am 1. Januar 2027. Die Ausgabe für Menschen zeigt Dollar; das JSON behält die dezimalen mcr-Felder, wobei 10.000.000 mcr US$1 sind.

Die gebuchten Hauptbucheinträge lesen.

billing statement [--cursor CURSOR] [--limit COUNT]

screenrig billing statement --limit 20

Einträge sind gebuchte Hauptbuchzeilen in US-Dollar in stabiler Reihenfolge. Reservierungen erscheinen als Sperren, nicht als gebuchte Einnahmen oder Ausgaben, und eine Korrektur verweist auf den ursprünglichen Eintrag, statt ihn umzuschreiben. Eine Werbebelastung ist für den Käufer sichtbar; ein Verkäufer sieht Brutto, Servicegebühr und Netto.