项目 CLI 命令

读取项目记录。

project show

无参数。

screenrig project show

设置人们在仪表板项目切换器中看到的名称。

project rename NAME

替换此登录令牌所覆盖的项目。

project token --projects IDS

screenrig project token --projects prj_01EXAMPLEPROJECT0000,prj_01EXAMPLEOTHER000000

替换整个子集；单独的 project list 不授予任何访问权限。响应丢失时，会保留轮换请求 ID，用于相同的重试。

读取项目计划、独立的 screens 和 advertiser 功能标志及有效能力集。路由拒绝优先于过时的能力读取。

project capabilities

读取项目在 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

范围和默认值与 screen uptime 相同。data.items 按 UTC 天列出一行，最旧在前：online_s 和 offline_s 汇总当天有记录状态的屏幕，availability、coverage（这些屏幕当天有记录状态的时间份额）和 screens（有记录状态的屏幕数量）。当天行覆盖已结束的区间；screen list 显示当前在线人员。

按 UTC 小时读取机群健康状况：报告的屏幕、热点、显示器断开、崩溃。

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 按 UTC 小时列出车队健康状况：hour、screens_reporting、hot（峰值温度达到或超过 80 °C）、display_disconnected 和 crashing（24 小时内 3 次或以上崩溃）。CLI 跟踪 next_cursor 至结束，并每小时响应 next_cursor null。小时报告最多延迟约 5 分钟。

将此项目的数据以开放格式写入目录。

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

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

DIR 获取以下内容的 JSON：项目、屏幕、屏幕文件夹、标签、各屏幕的排程、含所有修订的播放列表、活动、直接广告活动、卡片及其数据、数据源（绝不含其凭据）、通知、webhook（不含签名密钥和接收端 URL）、静音、应用元数据、触发器和报告订阅；media/files 中的原始媒体文件，其中 media/manifest.json 记录每个文件的 SHA-256；data/ 中的播放、回放、正常运行时间和警报 CSV；以及 log/events.jsonl 中的事件日志。export.json 最后写入，列出每个文件及其大小和 SHA-256，以及各部分的结果（ok、skipped 或 failed）。重新运行会保留完整的媒体文件，并继续未完成的文件。凭据无法读取的部分为 skipped；警告 export_section_failed 表示副本不完整，请再次运行同一命令。应用文件会报告为已省略，带有 complete: false 和警告 export_application_content_omitted，使用 --no-media 时也一样：请保留原始应用归档以便恢复。每个请求都是计费的 API 请求，媒体下载属于出站流量。

创建、列出或撤销项目成员、上传者和广告买家邀请。

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 默认为 member。电子邮件发送为默认方式，七天后过期。--email 支持逗号分隔的收件人，每次最多五十个。--link 仅限成员，不指定收件人，只返回一次邀请链接（有效期 24 小时），用于直接转交给目标对象。请勿将该链接写入日志、备注或共享记录。列表操作不会返回该链接。每个组织最多可有 50 个未处理的邀请。

广告买家仅使用电子邮件，需要拥有屏幕或广告位权限（或两者）。--screen-id 和 --slot-id 接受逗号分隔的 ID；--policy 选择 trusted 或 review_required。状态筛选器包括 queued、sent、issued、accepted、revoked、expired 和 failed。

--kind uploader 邀请一位仅在 --folder-id（至少一个）指定的媒体文件夹和 --playlist-id 指定的播放列表中工作的人员：他们可以向这些文件夹上传，并在这些播放列表中添加、替换和移除页面，仅此而已。他们的更改需等待审核，除非使用 --access manage；该选项只有能批准审核的人才可授予。带有 --screen-folder-id（每个文件夹包含其内的所有文件夹）或 --screen-id 的 --kind member 邀请，会把接受邀请的人限定在这些屏幕上。--folder-id、--playlist-id 和 --access 需要 --kind uploader，--slot-id 和 --policy 需要 --kind ad-buyer。详见 身份验证。

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

智能体不接受邀请。被邀请者打开邮件，登录或创建通行密钥，并在控制台接受。链接注册先验证其邮箱。撤销已接受的邀请不会取消成员身份；请使用买家成员控制撤销广告访问权限。

报告此安装是否持有可用凭证。

agent status

无参数。

screenrig agent status

只读。永不更改本地或服务器状态，且无任何费用。结果包含会话的 access、其 effective_access，以及当项目的审核设置或无审批权限的成员将其限制在较低级别时的 access_limited_by（project 或 person）。当项目将此智能体限制在某些屏幕文件夹和屏幕时，screen_scope 会列出它们（folder_ids，每个都包含其内的所有文件夹，以及 screen_ids），person_screen_scope 则是该智能体负责人的范围；智能体只对两者都允许的屏幕执行操作，对整个项目的智能体这两项均不出现。超出范围时，命令返回 outside_screen_scope（退出码 3）。新的项目备注或到期需要复查的备注会添加警告 notes_waiting。

撤销此智能体在当前项目中的成员资格。

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

screenrig agent disconnect --yes

仅撤销当前项目的成员资格：身份、其他成员资格、项目及其屏幕均保留。响应不明确时，本地凭据和重试状态会保留，因此重新运行是安全的。

撤销此身份及其所有项目成员资格。

agent revoke-identity --yes

screenrig agent revoke-identity --yes

确认撤销后，会清除每个已缓存项目的本地凭据和待处理工作。模糊失败会保留它们。

在控制台中获得某人批准后，或以服务客户端身份，将此安装登录到现有账户。

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

打印控制台地址和一个八字母代码到标准错误，然后等待最长 24 小时。人员检查代码是否匹配，并按一次连接，最近一小时内登录控制台后无第二次通行密钥提示。信封报告 status: signed_in、项目、组织和 access。在已登录安装上再次运行会添加项目或将只读或提议项目提升为管理。拒绝为 login_denied，过期为 login_expired。

服务客户端的配置必须是其专属文件：之后每个带有该 --config 的命令都以该客户端身份登录，每次读取私钥文件或密钥文件，并将令牌保存在内存中。

结束此安装的登录并移除其令牌。

logout

无参数。

screenrig logout

撤销服务器上的登录，然后移除存储的令牌并报告 status: signed_out。在服务客户端的配置中，它会移除已保存的客户端，并保留其私钥文件或密钥文件。可能未到达服务器的失败会保留它们，因此重新运行是安全的。运行 screenrig login 重新登录。

打开普通控制台 URL。此命令不生成登录链接、不创建会话，也不需要智能体凭证。

dashboard [open]

screenrig dashboard

控制台在登录后显示该人的项目。浏览器项目选择不更改绑定到智能体的项目。

请求无代理凭证的登录重置邮件。

dashboard reset-sign-in --email ADDRESS

确认不会透露该电子邮件是否有登录。邮件中的重置一小时后过期；用户创建新通行密钥。完成后替换登录凭据并撤销其他会话。当项目的所有权仍因注册而处于待定状态时，使用原始注册地址执行 --email 还会发送一封有效期七天的新注册邀请邮件；用户打开邀请并使用其登录接受，即可认领所有权。

检查此安装并按名称报告每次检查。

doctor [--repair-config]

screenrig doctor

data.checks 命名每个检查及其状态（pass、warn 或 fail）：Node 运行时、解析的配置路径及其权限、存储的凭据和登录的结束时间、控制平面来源及其服务路由、公布的 feedback 能力，以及可选的媒体工具链（ffmpeg、ffprobe、encoder_libx264、encoder_libx265、encoder_libwebp、cwebp、filter_hdr_tonemap）。

任何失败的检查都会使 doctor 以非零状态退出，而 warn 不会，因此在判定安装不健康之前，请先查看各个名称。缺失的媒体工具链只影响转换媒体的命令：media upload、media upload-batch、media replace 和 playlist init。

打印捆绑的 CLI 版本及其协议适配器。

version

无参数。

screenrig version

会话中先运行此命令。成功的信封证明启动器已解析捆绑的 CLI。--version 和 -V 可在命令行任何位置执行相同操作。

读取套餐的存储和智能体请求上限。

billing usage

无参数。

screenrig billing usage

data.stored_bytes 是已用存储，data.allowance.storage_bytes 是套餐的存储上限；超出上限的上传会以 quota_exceeded 被拒绝。data.allowance.requests_per_hour 是每小时智能体请求上限（面向人的输出中为 agent_requests_per_hour）。本小时剩余的请求数在每个被计数响应的 RateLimit 标头中。

以美元读取广告金额：剩余、已预留、可用和可支付的收入。

billing balance

无参数。

screenrig billing balance

广告主通过银行卡或 x402 机器支付来付款，价格和收入以美元计，付款从 2027 年 1 月 1 日开始。面向人的输出显示美元；JSON 保留十进制 mcr 成员，10,000,000 mcr 为 US$1。

读取已入账的账目条目。

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

screenrig billing statement --limit 20

条目是已入账的账本行，以美元计，顺序稳定。预留显示为冻结，不是已入账的收入或支出，更正会链接到原始条目而不是改写它。广告扣费对买方可见；卖方可看到总额、服务费和净额。