Early accessBy invitation, and the SDKs aren't published yet.Ask for an invitation
Skip to Content
Docs

Command-line tool

Lyrelog from your terminal. Search and follow events, read errors, sessions and people, manage projects, keys and organizations.

lyrelog is the dashboard in a terminal. It searches events with the explorer's filters, follows them live, and shows errors, sessions, people, releases, insights and usage. It also manages projects, keys, organizations and your account. Deleting your account or a project, and changing how you sign in (passkeys, linked accounts, two-step), stay in the dashboard: Lyrelog refuses them from the CLI, so a copied CLI session can't lock you out or erase your data.

It's made for two kinds of user. A person gets tables and colours. A program or a coding agent gets JSON and nothing else. The tool notices which one is running it (see How output switches).

Not published yet

Like the SDKs, the command-line tool isn't published during early access. Until it is, the go install below fails: the repository is private and has no release yet.

Install

You need Go 1.26 or later:

go install go.lyrelog.com/cli/cmd/lyrelog@latest

This puts lyrelog in $(go env GOPATH)/bin, so make sure that folder is on your PATH. No prebuilt binaries are published yet; Homebrew (brew install GonzaloFuentes28/tap/lyrelog) comes with the first release.

First steps

Sign in

lyrelog login

Your browser opens the dashboard. Approve this computer, and the terminal picks up the sign-in. There's another way over SSH; see Sign in.

Choose a project

lyrelog projects
lyrelog use tilefall          # its slug, its name or its id
   Project   Slug      Events  People  Errors  Last event  24 hours
●  Tilefall  tilefall   7,291     205     187  7m ago      ▂▄▃▅▃▄▅▆▆▇██▆▃▁▂▁▁▁▁▂▃▅▂

Commands use this project unless you pass -p <project>. If you can only see one project, lyrelog login picks it for you.

Look at events

lyrelog events --level error --since 7d
Tilefall · production · last 7 days

10:30:07 ▌error    cloud_save_failed  sync  reason=schema_mismatch record=progress status=422
10:27:43 ▌error    cloud_save_failed  sync  reason=schema_mismatch record=progress status=422
10:24:48 ▌error    cloud_save_failed  sync  reason=schema_mismatch record=progress status=422

Next, try lyrelog errors for problems grouped, worst first. Or lyrelog events -f to watch events as they arrive.

What it does

Look at your data
eventsSearch events as the explorer does; -f follows new ones. events get, summary, values, attributes
errorsProblems grouped by area and event name, worst first
sessionsSessions: who, how long, what happened, errors
peopleThe project's people, in its own word
personOne person: totals, recent sessions and events; export or delete their data
releasesEach app version's health
insightsTrends, rates and funnels
usageThis month's events against your plan
Set things up and more
projects, useList, show, change and make projects, and choose the default one
keysList, create and revoke API keys
orgsOrganizations, their people and invitations
accountYour name, and where you're signed in
tokensAccess tokens for CI: list, create, change the expiry, revoke
login, logout, whoamiSign in and out
openOpen the same page in the dashboard
apiCall any dashboard API route, signed in

Every command has --help, with examples.

How output switches

At a terminal, lyrelog draws tables with Lyrelog's colours. It writes JSON instead when:

  • its output goes into a pipe or a file (lyrelog errors | jq), or
  • a coding agent or CI runs it (Claude Code, Cursor, Codex and others, detected by the environment variables they set).

--json and --human force either one. In JSON mode, stdout carries only the data, errors are one JSON line on stderr, and the exit code says what went wrong. See For agents and scripts.

Colours adapt to light and dark terminals. Set LYRELOG_THEME=dark or light if the guess is wrong. NO_COLOR=1 or --no-color turns them off.