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

Referência

As flags globais da ferramenta de linha de comando, as variáveis de ambiente, o arquivo de configurações, o autocompletar do shell e a versão.

Flags globais

Todo comando aceita estas.

FlagO quê
-p, --projectO projeto: o id, o slug ou o nome dele. Padrão: o escolhido com lyrelog use.
--urlO endereço do painel. Padrão https://app.lyrelog.com, ou LYRELOG_URL.
--jsonEscrever JSON, mesmo num terminal
--humanEscrever tabelas e cores, mesmo num pipe
--no-colorSem cores (também NO_COLOR=1)
-h, --helpAjuda do comando, com exemplos

Variáveis de ambiente

VariávelO quê
LYRELOG_TOKENUm token de acesso (lyr_tok_..., de lyrelog tokens create ou da página da sua conta) ou um token de sessão da CLI. Tem prioridade sobre o login salvo. Veja Scripts e CI.
LYRELOG_URLO endereço do painel. --url tem prioridade sobre ela.
LYRELOG_CONFIG_DIRA pasta do arquivo de configurações
LYRELOG_THEMEdark ou light, quando o fundo do terminal é detectado errado
LYRELOG_AGENTQualquer valor: escrever JSON, como para um agente de código
NO_COLORQualquer valor: sem cores
BROWSERO navegador que lyrelog login e lyrelog open usam; none para nenhum navegador

A ferramenta também lê as variáveis que os agentes de código e as CIs definem, para decidir entre JSON e tabelas. Veja JSON ou tabelas.

Arquivo de configurações

A ferramenta guarda as suas configurações num único arquivo JSON, config.json, em:

Pasta
macOS e Linux~/.config/lyrelog, ou $XDG_CONFIG_HOME/lyrelog quando essa variável está definida
Windows%AppData%\lyrelog
Em qualquer sistemaLYRELOG_CONFIG_DIR, quando definida

Só você pode ler o arquivo (modo 0600, numa pasta 0700), e ele é gravado de uma só vez, então nunca fica pela metade. Ele contém:

CampoO quê
urlO servidor usado quando nem --url nem LYRELOG_URL dizem outra coisa: o último em que você entrou
hostsUma entrada por servidor, indexada pelo endereço dele
hosts.*.tokenA sessão. A ferramenta nunca a exibe.
hosts.*.expires_atQuando a sessão termina, no mais tardar (segundos Unix)
hosts.*.user_email, hosts.*.user_nameA quem ela pertence
hosts.*.project, hosts.*.project_nameO id do projeto padrão, e o nome dele para as mensagens
{
  "url": "https://app.lyrelog.com",
  "hosts": {
    "https://app.lyrelog.com": {
      "token": "…",
      "expires_at": 1797714620,
      "user_email": "alex@example.com",
      "user_name": "Alex Rivera",
      "project": "e8bc11c6e22f",
      "project_name": "Tilefall"
    }
  }
}

O token é uma sessão, como o cookie de um navegador: qualquer pessoa que o copie age como você até ele terminar. lyrelog logout o encerra no servidor e o remove do arquivo.

Códigos de saída

0 é sucesso; qualquer outro diz o que deu errado (2 uma flag errada, 3 sem ter entrado, 4 é preciso um login recente, 6 não encontrado...). A tabela completa está em Para agentes e scripts.

Autocompletar do shell

lyrelog completion imprime um script de autocompletar para bash, zsh, fish ou powershell. O --help de cada um diz onde colocá-lo. Para o zsh:

source <(lyrelog completion zsh)                                            # this shell only
lyrelog completion zsh > "$(brew --prefix)/share/zsh/site-functions/_lyrelog"   # macOS, every shell
lyrelog completion zsh > "${fpath[1]}/_lyrelog"                             # Linux, every shell

O autocompletar precisa de autoload -U compinit; compinit no seu ~/.zshrc. Abra um shell novo depois.

Versão

lyrelog version
lyrelog v0.1.0 (4678ef1, built 2026-11-19, go1.27.4, darwin/arm64)

Mostra a versão (da release, ou a que o go install baixou), o commit e a data da build quando a build os conhece, e a versão do Go e o sistema para o qual foi compilada. Uma build sem versão diz dev. Em JSON: {"version","commit","date","go","os","arch"}.