Projetos: comandos da CLI

Lê o registro do projeto.

project show

Sem parâmetros.

screenrig project show

Defina o nome que as pessoas veem no seletor de projetos do dashboard.

project rename NAME

Substituir os projetos que o token deste login cobre.

project token --projects IDS

screenrig project token --projects prj_01EXAMPLEPROJECT0000,prj_01EXAMPLEOTHER000000

Substitui o subconjunto inteiro; project list sozinho não concede acesso. Uma resposta perdida mantém o id da solicitação de rotação para uma nova tentativa idêntica.

Ler o plano do projeto, flags de recurso independentes screens e advertiser, e conjunto de capacidades efetivas. Uma negação de rota prevalece sobre uma leitura de capacidade desatualizada.

project capabilities

Ler a disponibilidade diária de telas do projeto ao longo dos dias 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

Intervalo e padrões são os de screen uptime. data.items lista uma linha por dia UTC, do mais antigo para o mais recente: online_s e offline_s somados sobre as telas com estado registrado naquele dia, availability, coverage (a parte do dia dessas telas com estado registrado) e screens (quantas tiveram estado registrado). A linha de hoje cobre intervalos que terminaram até agora; screen list mostra quem está online agora.

Ler a saúde da frota por hora UTC: telas reportando, quente, display desconectado, travando.

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 lista a saúde da frota por hora UTC: hour, screens_reporting, hot (temperatura máxima igual ou acima de 80 °C), display_disconnected, e crashing (3 ou mais falhas em 24 horas). O CLI segue next_cursor até o fim e responde a cada hora com next_cursor null. As horas seguem os relatórios com até cerca de 5 minutos de atraso.

Gravar os dados deste projeto em um diretório em formatos abertos.

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

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

DIR obtém JSON do projeto, telas, pastas de telas, tags, programações por tela, playlists com todas as revisões, campanhas, campanhas diretas, cartões e seus dados, fontes (nunca suas credenciais), notificações, webhooks (sem segredos de assinatura nem URLs de receptores), silenciamentos, metadados de aplicativos, gatilhos e assinaturas de relatórios; os arquivos de mídia originais em media/files, com media/manifest.json contendo o SHA-256 de cada arquivo; CSV de plays, reprodução, uptime e alertas em data/; e o registro de eventos em log/events.jsonl. export.json é gravado por último e lista cada arquivo com seu tamanho e SHA-256 e o resultado de cada seção (ok, skipped ou failed). Uma nova execução mantém os arquivos de mídia completos e continua os parciais. Uma seção que a credencial não pode ler é skipped; o aviso export_section_failed indica que a cópia está incompleta, então execute o mesmo comando novamente. Os arquivos de aplicativos são reportados como omitidos com complete: false e o aviso export_application_content_omitted, inclusive com --no-media: mantenha os arquivos originais dos aplicativos para recuperação. Cada solicitação é uma solicitação de API cobrada, e os downloads de mídia são tráfego de saída.

Criar, listar ou revogar convites para membros do projeto, uploaders e compradores de anúncios.

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 tem member como padrão. A entrega por e-mail é o padrão e expira após sete dias. --email aceita destinatários separados por vírgula, até cinquenta por solicitação. --link é somente para membros, não nomeia nenhum destinatário e retorna uma vez uma URL de convite de vinte e quatro horas para entrega direta à pessoa pretendida. Nunca coloque essa URL em logs, notas ou transcrição compartilhada. As listas nunca a retornam. No máximo 50 convites podem estar pendentes por organização.

Compradores de anúncios usam apenas e-mail e precisam de escopo de tela ou slot próprio (ou ambos). --screen-id e --slot-id aceitam IDs separados por vírgula; --policy seleciona trusted ou review_required. Filtros de status são queued, sent, issued, accepted, revoked, expired e failed.

--kind uploader convida uma pessoa que trabalha apenas nas pastas de mídia indicadas com --folder-id (pelo menos uma) e nas playlists indicadas com --playlist-id: ela faz upload para essas pastas e adiciona, substitui e remove páginas dessas playlists, e nada mais. As alterações dela aguardam revisão, a menos que --access manage, algo que só quem pode aprovar revisões pode conceder. Um convite --kind member com --screen-folder-id (cada pasta inclui todas as pastas dentro dela) ou --screen-id limita a pessoa que aceita a essas telas. --folder-id, --playlist-id e --access exigem --kind uploader, e --slot-id e --policy exigem --kind ad-buyer. Veja Autenticação.

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

Agentes não aceitam convites. A pessoa convidada abre o e-mail, faz login ou cria uma passkey, e aceita no dashboard. O cadastro por link verifica o e-mail primeiro. Revogar um convite aceito não desfaz uma associação; use os controles de associação do comprador para revogar o acesso à publicidade.

Relatar se esta instalação possui uma credencial utilizável.

agent status

Sem parâmetros.

screenrig agent status

Somente leitura. Nunca altera estado local ou do servidor, e não custa nada. O resultado traz o access da sessão, seu effective_access e, quando a configuração de revisão do projeto ou um membro que não pode aprovar o mantém em nível inferior, access_limited_by (project ou person). Quando o projeto limita este agente a pastas de telas e telas, screen_scope as lista (folder_ids, cada uma com todas as pastas dentro dela, e screen_ids) e person_screen_scope é o escopo da pessoa responsável pelo agente; o agente age apenas nas telas que ambos permitem, e ambos estão ausentes para um agente do projeto inteiro. Fora do escopo, um comando responde outside_screen_scope (saída 3). Notas novas do projeto, ou notas que precisam de revisão, acrescentam o aviso notes_waiting.

Revogar a associação deste agente ao projeto atual.

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

screenrig agent disconnect --yes

Revoga apenas a associação ao projeto atual: a identidade, as outras associações, o projeto e suas telas permanecem. As credenciais locais e o estado de tentativa permanecem quando a resposta é ambígua, então executar novamente é seguro.

Revogar esta identidade e todas as suas associações a projetos.

agent revoke-identity --yes

screenrig agent revoke-identity --yes

A revogação confirmada apaga as credenciais locais e o trabalho pendente de todos os projetos em cache. Uma falha ambígua os mantém.

Faça login desta instalação em uma conta existente, com aprovação de uma pessoa no dashboard, ou como um cliente de serviço.

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 o endereço do dashboard e um código de oito letras no stderr, depois espera até 24 horas. A pessoa verifica se o código corresponde e pressiona Conectar uma vez, sem segundo prompt de passkey após login no dashboard na última hora. O envelope reporta status: signed_in, o projeto, a organização e access. Executar novamente em uma instalação logada adiciona um projeto ou eleva de Somente leitura ou Propor projeto para Gerenciar. Negação é login_denied e expiração é login_expired.

A configuração de um cliente de serviço deve ser um arquivo próprio: todo comando posterior com esse --config faz login como o cliente, lendo o arquivo de chave ou de segredo a cada vez e mantendo o token na memória.

Encerrar o login desta instalação e remover seus tokens.

logout

Sem parâmetros.

screenrig logout

Revoga o login no servidor, depois remove os tokens armazenados e reporta status: signed_out. Na configuração de um cliente de serviço, remove o cliente salvo e deixa seu arquivo de chave ou de segredo. Uma falha que pode não ter alcançado o servidor os mantém, então executar novamente é seguro. Execute screenrig login para entrar novamente.

Abra a URL comum do dashboard. Este comando não gera um link de login, cria uma sessão ou precisa de credencial de agente.

dashboard [open]

screenrig dashboard

O dashboard mostra os projetos da pessoa após o login. A seleção de projeto no navegador não altera o projeto vinculado a um agente.

Solicitar um e-mail de redefinição de login sem credencial de agente.

dashboard reset-sign-in --email ADDRESS

O reconhecimento não revela se o e-mail tem um login. O reset enviado por e-mail expira após uma hora; a pessoa cria uma nova passkey. A conclusão substitui suas credenciais de login e revoga outras sessões. Enquanto a propriedade do projeto ainda está pendente desde a inscrição, --email com o endereço de inscrição original também envia por e-mail um novo convite de inscrição de sete dias; a pessoa o abre e o aceita com seu login para reivindicar a propriedade.

Verifique esta instalação e relate cada verificação pelo nome.

doctor [--repair-config]

screenrig doctor

data.checks nomeia cada verificação e seu status (pass, warn ou fail): o runtime Node, o caminho de configuração resolvido e suas permissões, a credencial armazenada e o fim do login, a origem do plano de controle e suas rotas de serviço, a capacidade feedback anunciada, e a cadeia de ferramentas de mídia opcional (ffmpeg, ffprobe, encoder_libx264, encoder_libx265, encoder_libwebp, cwebp, filter_hdr_tonemap).

Qualquer verificação falhada faz doctor sair com código diferente de zero, e warn não faz isso, então leia os nomes individuais antes de chamar a instalação de não saudável. Uma cadeia de ferramentas de mídia ausente afeta apenas os comandos que convertem mídia: media upload, media upload-batch, media replace e playlist init.

Imprime a versão do CLI empacotada e seu adaptador de protocolo.

version

Sem parâmetros.

screenrig version

Execute isto primeiro em uma sessão. Um envelope bem-sucedido prova que o launcher resolveu o CLI incluído. --version e -V fazem a mesma coisa de qualquer lugar na linha de comando.

Lê os limites de armazenamento e de solicitações de agente do plano.

billing usage

Sem parâmetros.

screenrig billing usage

data.stored_bytes é o armazenamento usado e data.allowance.storage_bytes o limite de armazenamento do plano; um upload além dele é recusado com quota_exceeded. data.allowance.requests_per_hour é o limite por hora de solicitações de agente (agent_requests_per_hour na saída para pessoas). As solicitações restantes nesta hora estão no cabeçalho RateLimit de cada resposta contada.

Lê os valores de publicidade em dólares americanos: restante, reservado, disponível e ganhos pagáveis.

billing balance

Sem parâmetros.

screenrig billing balance

Os anunciantes pagam com cartão ou com pagamento de máquina x402, os preços e os ganhos são em dólares americanos e os pagamentos começam em 1º de janeiro de 2027. A saída para pessoas mostra dólares; o JSON mantém os membros decimais mcr, em que 10.000.000 mcr são US$1.

Ler as entradas lançadas do livro-razão.

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

screenrig billing statement --limit 20

As entradas são linhas do livro-razão lançadas, em dólares americanos, em ordem estável. As reservas aparecem como bloqueios, não como ganhos ou gastos lançados, e uma correção aponta para a entrada original em vez de reescrevê-la. Uma cobrança de publicidade é visível ao comprador; o vendedor vê o bruto, a taxa de serviço e o líquido.