Acesso antecipadoSó por convite, e os SDKs ainda não foram publicados.Pedir um convite
Ir para o conteúdo
Docs

Projetos, chaves e organizações

Escolha um projeto, mude as configurações dele, crie e revogue chaves, convide pessoas e veja a sua conta, pelo terminal.

Mudar configurações, chaves e pessoas funciona como no painel, com as mesmas regras. Os proprietários fazem o que só os proprietários podem fazer. Criar uma chave de servidor, de leitura ou de administração exige um login recente. Tudo o que não pode ser desfeito pede confirmação antes.

Apagar um projeto ou a sua conta, e mudar a forma como você entra, só acontece no painel (veja Apagar um projeto e Apagar a sua conta). O Lyrelog recusa essas ações vindas da CLI, mesmo por lyrelog api, com 403 e "browser_only": true.

Projetos

lyrelog projects lista os projetos que você pode ver, com os eventos, as pessoas e os erros das últimas 24 horas, como o seletor de projetos do painel.

   Project   Slug      Events  People  Errors  Last event  24 hours
●  Tilefall  tilefall   5,593     177     103  50m ago     █▆▂▂▁▂▂▂▁▆▇▇▇▆▇█▆██▁ ▁▁

Qualquer comando aceita -p (--project) com o slug, o nome ou o id de um projeto (os 12 caracteres no endereço do painel).

use

Escolhe o projeto que os comandos usam quando -p não é passado. Fica salvo para este servidor no arquivo de configurações.

lyrelog use tilefall
lyrelog use e8bc11c6e22f
lyrelog use              # show the current one
lyrelog use --clear      # forget it

projects show

As configurações de um projeto. Passe um projeto, ou ele mostra o padrão.

lyrelog projects show
Tilefall e8bc11c6e22f

  Slug                 tilefall
  Your role            owner
  Keeps events for     7 days (your plan keeps up to 7)
  Opens on             production
  Platforms            ios
  Its people are       player / players
  App Attest App IDs   ABCDE12345.com.example.tilefall
  Verified events      everything is accepted
  Created              Nov 19, 2026

projects set

Muda as configurações de um projeto, como a página de configurações dele. Só proprietários. Só mudam as flags que você passa. Uma lista substitui o que existe, e "" a esvazia.

lyrelog projects set --retention-days 30 --default-env production
lyrelog projects set --people player,players
lyrelog projects set --require-verified ios,android
lyrelog projects set --attest-app-ids ABCDE12345.com.example.tilefall
FlagO quê
--nameO nome do projeto
--retention-daysGuardar os eventos por esse número de dias, até o que o plano guarda (veja Retenção)
--default-envO ambiente em que o painel abre (all para todos)
--peopleComo o projeto chama as suas pessoas, singular,plural: player,players
--platformO que ele é principalmente: ios, android, web, api ou other
--platformsDo que ele é feito: ios, android, macos, web, api, separados por vírgula
--require-verifiedPlataformas das quais ele só aceita eventos verificados; "" aceita tudo
--attest-app-idsOs App IDs com que os apps dele se atestam no Apple App Attest (TEAMID.bundle.id); "" desliga

projects create

Cria um projeto numa das suas organizações. Só proprietários da organização. Ele imprime uma única vez a primeira chave de ingestão do projeto: coloque-a no seu app.

lyrelog projects create --name "Tilefall web" --slug tilefall-web
FlagO quê
--nameO nome do projeto
--slugUm nome curto para URLs: letras minúsculas, dígitos e hifens
--orgA organização, pelo id ou pelo nome. Padrão: a sua única organização, ou a do projeto padrão.

projects platform

Adiciona ou remove uma das plataformas de que um projeto é feito, com os seus detalhes. Só proprietários.

lyrelog projects platform add web --url https://tilefall.example
lyrelog projects platform add android --package com.example.tilefall
lyrelog projects platform add api --runtime python
lyrelog projects platform remove web
FlagO quê
--urlweb: o endereço do site
--packageandroid: o pacote no Google Play
--runtimeapi: a linguagem do servidor

As plataformas são ios, android, macos, web e api.

Chaves

lyrelog keys (ou keys list) lista as chaves de API do projeto, incluindo as revogadas. Os tipos são os de Chaves:

TipoComeça comO que é
ingestlyr_ing_Pública e só de escrita: vai dentro do seu app
serverlyr_srv_Secreta: envia eventos verificados a partir dos seus servidores
readlyr_read_Secreta: lê todos os eventos do projeto
adminlyr_adm_Secreta: lê e gerencia o projeto pela API (Full access no painel)
ID                                    Name           Type    Starts with    Created  Last used  Status
0d5c55e6-d922-4cd2-af90-3fff4e8709b7  tilefall-ser…  server  lyr_srv_7GLL…  51m ago  51m ago    active
d3c65585-ab3f-427f-abee-13893f96c53a  tilefall-ing…  ingest  lyr_ing_ptD_…  1h ago   1h ago     active
9c81961c-3b29-47ac-b580-50c444f40372  x              read    lyr_read_Dg7…  3m ago   never      revoked 2m ago

keys create

Cria uma chave. Só proprietários. O segredo dela é impresso uma única vez, porque só um hash dele é guardado.

lyrelog keys create --type ingest --name "iOS app"
lyrelog keys create --type server --name tilefall-api --json | jq -r .secret
FlagO quê
--typeingest (padrão), server, read ou admin
--nameOnde a chave é usada

Uma chave server, read ou admin exige ter entrado nos últimos 10 minutos. Se o seu login for mais antigo, o comando para com "This needs a recent sign-in". Rode lyrelog login e depois crie a chave. Um projeto tem no máximo 20 chaves ativas.

keys revoke

lyrelog keys revoke 9c81961c-3b29-47ac-b580-50c444f40372

Revoga uma chave. Só proprietários. O que a usa para de funcionar. Ele pede confirmação antes; -y (--yes) pula a pergunta, e o modo JSON exige essa flag.

Organizações

lyrelog orgs lista as suas organizações, o seu papel em cada uma e o plano dela. lyrelog orgs show lista as pessoas e os convites em aberto de uma delas.

lyrelog orgs show
Alex Rivera 4 · Free plan · you're owner

Name         Email             Role   Since         Last sign-in
Alex Rivera  alex@example.com  owner  Nov 19, 2026  3m ago

Os comandos abaixo são para proprietários. Cada um aceita --org com um id ou um nome. Sem ele, usam a sua única organização, ou a do projeto padrão.

ComandoO quê
orgs rename <name>Renomear a organização
orgs inviteCriar um link de convite (7 dias, funciona uma vez). --role owner ou member (padrão); --email o envia por e-mail.
orgs revoke-invite <invite-id>Cancelar um convite em aberto
orgs role <member> <owner|member>Mudar o papel de alguém. O membro é o e-mail ou o id de usuário da pessoa.
orgs remove <member>Remover alguém. Qualquer pessoa pode remover a si mesma, para sair. Pede confirmação antes; --yes pula a pergunta.
lyrelog orgs invite --role member --email ana@example.com
lyrelog orgs role ana@example.com owner

O link de um convite é impresso uma única vez. Qualquer pessoa com ele pode entrar na organização com esse papel. Uma organização sempre mantém um proprietário, então uma mudança que a deixaria sem nenhum é recusada.

Conta

lyrelog account mostra a sua conta como a página da conta mostra: o seu e-mail, as passkeys e a verificação em duas etapas.

Alex Rivera alex@example.com

  Email            ✓ confirmed
  Passkeys         none
  Two-step         off
ComandoO quê
account set --name <name>Mudar o seu nome
account sessionsOnde você entrou: navegadores e computadores com a CLI (não os tokens de acesso)
account sign-out <session-id>Encerrar uma dessas sessões

Adicionar passkeys ou formas de entrar e ligar a verificação em duas etapas acontece no navegador (lyrelog open account). Veja Entrar para as sessões.

Tokens de acesso

Um token de acesso (lyr_tok_...) permite que uma CI ou um script use a CLI ou a API como você, via LYRELOG_TOKEN (veja Scripts e CI). A seção Access tokens da página da conta faz o mesmo que estes comandos.

lyrelog tokens (ou tokens list) lista os seus:

Name                    ID  Expires      Last used
GitHub Actions, deploy  45  Feb 3, 2027  1h ago
nightly export          46  ⚠ never      Oct 1
ComandoO quê
tokens create --name <name>Criar um token. --expires 30d, 90d (padrão), 1y ou never. Ele é impresso uma única vez.
tokens expiry <id> --expires <when>Mudar quando ele expira, contado a partir de agora: 30d, 90d, 1y ou never
tokens revoke <id>Revogá-lo. O que o usa para de funcionar. Pede confirmação antes; -y (--yes) pula a pergunta.
lyrelog login
lyrelog tokens create --name "GitHub Actions, deploy"
✓ Made the access token GitHub Actions, deploy, it expires Feb 17, 2027

  Token:

    lyr_tok_…

  Copy it now: Lyrelog shows it only once. It's a secret: store it in your CI's secrets as LYRELOG_TOKEN.

Criar um token, e fazer um durar mais ou nunca expirar, exige ter entrado nos últimos 10 minutos: logo depois de lyrelog login. Senão, o comando para com "This needs a recent sign-in" (saída 4). Encurtar a validade funciona a qualquer momento. Um token de acesso não pode criar nem alterar tokens, então estes comandos se recusam a rodar com LYRELOG_TOKEN definido como um token desses (saída 5, browser_only).

Um token que nunca expira recebe um aviso, e no modo JSON --expires never exige --yes. No modo JSON, tokens create imprime {"token","session","never_expires"}:

lyrelog tokens create --name ci --expires 90d --json | jq -r .token