Projets : commandes CLI

Lire la fiche du projet.

project show

Aucun paramètre.

screenrig project show

Définir le nom que les gens voient dans le sélecteur de projet du tableau de bord.

project rename NAME

Remplacer les projets couverts par le jeton de cette connexion.

project token --projects IDS

screenrig project token --projects prj_01EXAMPLEPROJECT0000,prj_01EXAMPLEOTHER000000

Remplace tout le sous-ensemble ; project list seul n’accorde aucun accès. Une réponse perdue conserve l’identifiant de demande de rotation pour une nouvelle tentative identique.

Lire le forfait du projet, les indicateurs de fonctionnalités indépendants screens et advertiser et l’ensemble des capacités effectives. Un refus de route l’emporte sur une lecture périmée des capacités.

project capabilities

Lire la disponibilité quotidienne des écrans du projet sur des jours UTC.

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

La plage et les valeurs par défaut sont celles de screen uptime. data.items liste une ligne par jour UTC, du plus ancien au plus récent : online_s et offline_s cumulés sur les écrans avec un état enregistré ce jour-là, availability, coverage (la part de la journée de ces écrans avec un état enregistré), et screens (combien avaient un état enregistré). La ligne d’aujourd’hui couvre les intervalles terminés jusqu’à présent ; screen list montre qui est en ligne maintenant.

Lire la santé de la flotte par heure UTC : écrans rapportant, chauds, afficheur déconnecté, plantage.

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 liste la santé de la flotte par heure UTC : hour, screens_reporting, hot (température maximale à 80 °C ou plus), display_disconnected, et crashing (3 crashs ou plus en 24 heures). Le CLI suit next_cursor jusqu’à la fin et répond chaque heure avec next_cursor null. Les heures suivent les rapports avec un délai d’environ 5 minutes.

Écrire les données de ce projet dans un répertoire en formats ouverts.

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

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

DIR obtient du JSON pour le projet, les écrans, les dossiers d’écrans, les étiquettes, les programmations par écran, les listes de lecture avec chaque révision, les campagnes, les campagnes directes, les cartes et leurs données, les sources (jamais leurs identifiants), les notifications, les webhooks (sans secrets de signature ni URL de récepteur), les mises en sourdine, les métadonnées d’application, les déclencheurs et les abonnements aux rapports ; les fichiers médias d’origine dans media/files, avec media/manifest.json contenant le SHA-256 de chaque fichier ; des CSV des lectures, de la lecture, de la disponibilité et des alertes dans data/ ; et le journal des événements dans log/events.jsonl. export.json est écrit en dernier et énumère chaque fichier avec sa taille et son SHA-256, ainsi que le résultat de chaque section (ok, skipped ou failed). Une nouvelle exécution conserve les fichiers médias complets et poursuit les fichiers partiels. Une section que l’identifiant ne peut pas lire est skipped ; l’avertissement export_section_failed signifie que la copie est incomplète, donc exécutez de nouveau la même commande. Les fichiers d’application sont signalés comme omis avec complete: false et l’avertissement export_application_content_omitted, y compris avec --no-media : conservez les archives d’application d’origine pour la récupération. Chaque requête est une requête API facturée, et les téléchargements de médias sont de la sortie.

Créer, lister ou révoquer des invitations de membres de projet, de téléverseurs et d’acheteurs de publicité.

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 utilise member par défaut. La livraison par courriel est la valeur par défaut et expire après sept jours. --email accepte des destinataires séparés par des virgules, jusqu’à cinquante par demande. --link est réservé aux membres, ne nomme aucun destinataire, et renvoie une seule fois une URL d’invitation valide vingt-quatre heures pour un transfert direct à la personne visée. Ne mettez jamais cette URL dans des journaux, notes ou une transcription partagée. Les listes ne la renvoient jamais. Au plus 50 invitations peuvent être en attente par organisation.

Les acheteurs d’annonces utilisent uniquement le courriel et ont besoin d’un écran ou d’un périmètre de créneau possédé (ou les deux). --screen-id et --slot-id acceptent des ID séparés par des virgules ; --policy sélectionne trusted ou review_required. Les filtres de statut sont queued, sent, issued, accepted, revoked, expired et failed.

--kind uploader invite une personne qui travaille uniquement dans les dossiers médias indiqués avec --folder-id (au moins un) et dans les listes de lecture indiquées avec --playlist-id : elle téléverse dans ces dossiers et ajoute, remplace et supprime des pages de ces listes de lecture, et rien d’autre. Ses changements attendent une revue, sauf avec --access manage, que seule une personne pouvant approuver les revues peut accorder. Une invitation --kind member avec --screen-folder-id (chaque dossier inclut tous les dossiers qu’il contient) ou --screen-id limite la personne qui l’accepte à ces écrans. --folder-id, --playlist-id et --access nécessitent --kind uploader, et --slot-id et --policy nécessitent --kind ad-buyer. Voir Authentification.

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

Les agents n’acceptent pas les invitations. La personne invitée ouvre le courriel, se connecte ou crée une clé d’accès, et accepte dans le tableau de bord. L’inscription par lien vérifie d’abord leur courriel. Révoquer une invitation acceptée ne supprime pas une adhésion; utilisez les contrôles d’adhésion acheteur pour révoquer l’accès publicitaire.

Signaler si cette installation détient une crédentiale utilisable.

agent status

Aucun paramètre.

screenrig agent status

Lecture seule. Ne modifie jamais l’état local ou serveur, et ne coûte rien. Le résultat porte le access de session, son effective_access et, quand le paramètre de revue du projet ou un membre sans droit d’approbation le maintient plus bas, access_limited_by (project ou person). Lorsque le projet limite cet agent à des dossiers d’écrans et à des écrans, screen_scope les énumère (folder_ids, chacun avec tous les dossiers qu’il contient, et screen_ids) et person_screen_scope est la portée de la personne responsable de l’agent ; l’agent agit uniquement sur les écrans que les deux autorisent, et les deux sont absents pour un agent de l’ensemble du projet. En dehors de la portée, une commande répond outside_screen_scope (code de sortie 3). Les nouvelles notes du projet, ou les notes à passer en revue, ajoutent l’avertissement notes_waiting.

Révoquer l’adhésion de cet agent au projet actuel.

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

screenrig agent disconnect --yes

Révoque uniquement l’adhésion au projet actuel : l’identité, les autres adhésions, le projet et ses écrans demeurent. Les identifiants locaux et l’état de nouvelle tentative restent lorsque la réponse est ambiguë, donc relancer est sans risque.

Révoquer cette identité et toutes ses adhésions aux projets.

agent revoke-identity --yes

screenrig agent revoke-identity --yes

Une révocation confirmée efface les identifiants locaux et le travail en attente de chaque projet en cache. Un échec ambigu les conserve.

Connectez cette installation à un compte existant, avec l’approbation d’une personne dans le tableau de bord, ou en tant que client de service.

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

Imprime l’adresse du tableau de bord et un code de huit lettres sur stderr, puis attend jusqu’à 24 heures. La personne vérifie que le code correspond et appuie une fois sur Connecter, sans deuxième invite de clé d’accès après une connexion au tableau de bord dans l’heure précédente. L’enveloppe rapporte status: signed_in, le projet, l’organisation et access. L’exécuter à nouveau sur une installation connectée ajoute un projet ou élève un projet en lecture seule ou à proposer en gestion. Le refus est login_denied et l’expiration est login_expired.

La configuration d’un client de service doit être son propre fichier : chaque commande ultérieure avec ce --config se connecte en tant que client, lit le fichier de clé ou de secret à chaque fois et garde le jeton en mémoire.

Terminer la connexion de cette installation et supprimer ses jetons.

logout

Aucun paramètre.

screenrig logout

Révoque la connexion sur le serveur, puis supprime les jetons stockés et rapporte status: signed_out. Dans la configuration d’un client de service, elle supprime le client enregistré et laisse son fichier de clé ou de secret. Un échec qui n’a peut-être pas atteint le serveur les conserve, donc relancer est sans risque. Exécutez screenrig login pour vous reconnecter.

Ouvrez l’URL ordinaire du tableau de bord. Cette commande ne crée pas de lien de connexion, ne crée pas de session et ne nécessite pas d’identifiant d’agent.

dashboard [open]

screenrig dashboard

Le tableau de bord affiche les projets de la personne après connexion. La sélection de projet dans le navigateur ne change pas le projet lié à un agent.

Demander un courriel de réinitialisation de connexion sans justificatif d’agent.

dashboard reset-sign-in --email ADDRESS

L’accusé de réception ne révèle pas si le courriel a une connexion. La réinitialisation envoyée par courriel expire après une heure ; la personne crée une nouvelle clé d’accès. La complétion remplace ses identifiants de connexion et révoque les autres sessions. Tant que la propriété du projet est encore en attente depuis l’inscription, --email avec l’adresse d’inscription d’origine envoie aussi par courriel une nouvelle invitation d’inscription valide sept jours ; la personne l’ouvre et l’accepte avec sa connexion pour revendiquer la propriété.

Vérifiez cette installation et signalez chaque vérification par nom.

doctor [--repair-config]

screenrig doctor

data.checks nomme chaque vérification et son statut (pass, warn ou fail) : le runtime Node, le chemin de configuration résolu et ses permissions, l’identifiant stocké et la fin de la connexion, l’origine du plan de contrôle et ses routes de service, la capacité feedback annoncée, et la chaîne d’outils multimédias optionnelle (ffmpeg, ffprobe, encoder_libx264, encoder_libx265, encoder_libwebp, cwebp, filter_hdr_tonemap).

Toute vérification échouée fait sortir doctor avec un code non nul, ce que ne fait pas un warn, donc lisez les noms individuels avant de déclarer l’installation non saine. Une chaîne d’outils média manquante n’affecte que les commandes qui convertissent des médias : media upload, media upload-batch, media replace et playlist init.

Imprime la version CLI intégrée et son adaptateur de protocole.

version

Aucun paramètre.

screenrig version

Exécutez ceci en premier dans une session. Une enveloppe réussie prouve que le lanceur a résolu le CLI intégré. --version et -V font la même chose depuis n’importe où dans la ligne de commande.

Lire les limites de stockage et de requêtes d’agent du forfait.

billing usage

Aucun paramètre.

screenrig billing usage

data.stored_bytes est le stockage utilisé et data.allowance.storage_bytes la limite de stockage du forfait; un téléversement qui la dépasse est refusé avec quota_exceeded. data.allowance.requests_per_hour est le plafond horaire de requêtes d’agent (agent_requests_per_hour dans la sortie pour humains). Les requêtes restantes pour cette heure figurent dans l’en-tête RateLimit de chaque réponse comptée.

Lire les montants publicitaires en dollars américains : restant, réservé, disponible et revenus payables.

billing balance

Aucun paramètre.

screenrig billing balance

Les annonceurs paient par carte ou par paiement machine x402, les prix et les revenus sont en dollars américains, et les versements commencent le 1er janvier 2027. La sortie pour humains affiche des dollars; le JSON conserve les membres décimaux mcr, où 10 000 000 mcr valent US$1.

Lire les entrées publiées du grand livre.

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

screenrig billing statement --limit 20

Les entrées sont des lignes du grand livre comptabilisées, en dollars américains, dans un ordre stable. Les réservations apparaissent comme des retenues, non comme des revenus ou des dépenses comptabilisés, et une correction renvoie à l’entrée d’origine au lieu de la réécrire. Un débit publicitaire est visible pour l’acheteur; un vendeur voit son brut, les frais de service et son net.