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

Projects, keys and organizations

Choose a project, change its settings, make and revoke keys, invite people and see your account, from the terminal.

Changing settings, keys and people works as it does in the dashboard, with the same rules. Owners do what only owners can do. Creating a server, read or admin key needs a recent sign-in. Anything that can't be undone asks first.

Deleting a project or your account, and changing how you sign in, happen only in the dashboard (see Deleting a project and Deleting your account). Lyrelog refuses them from the CLI, even through lyrelog api, with 403 and "browser_only": true.

Projects

lyrelog projects lists the projects you can see, with their events, people and errors in the last 24 hours, as the dashboard's project switcher does.

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

Any command takes -p (--project) with a project's slug, its name or its id (the 12 characters in the dashboard's address).

use

Chooses the project commands use when -p isn't given. It's saved for this server in the settings file.

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

projects show

A project's settings. Pass a project, or it shows the default one.

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

Changes a project's settings, as its settings page does. Owners only. Only the flags you pass change. A list replaces what's there, and "" empties it.

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
FlagWhat
--nameThe project's name
--retention-daysKeep events this many days, up to what the plan keeps (see Retention)
--default-envThe environment the dashboard opens on (all for every one)
--peopleWhat the project calls its people, singular,plural: player,players
--platformWhat it mainly is: ios, android, web, api or other
--platformsWhat it's made of: ios, android, macos, web, api, comma separated
--require-verifiedPlatforms it accepts only verified events from; "" accepts everything
--attest-app-idsApp IDs its apps attest as with Apple App Attest (TEAMID.bundle.id); "" turns it off

projects create

Makes a project in one of your organizations. Organization owners only. It prints the project's first ingest key once: put it in your app.

lyrelog projects create --name "Tilefall web" --slug tilefall-web
FlagWhat
--nameThe project's name
--slugA short name for URLs: lowercase letters, digits and dashes
--orgThe organization, by id or name. Default: your only one, or the default project's.

projects platform

Adds or removes one of the platforms a project is made of, with its details. Owners only.

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
FlagWhat
--urlweb: the website's address
--packageandroid: the Google Play package
--runtimeapi: the server's language

The platforms are ios, android, macos, web and api.

Keys

lyrelog keys (or keys list) lists the project's API keys, revoked ones included. The types are those of Keys:

TypeStarts withWhat it is
ingestlyr_ing_Public and write-only: it ships in your app
serverlyr_srv_Secret: sends verified events from your servers
readlyr_read_Secret: reads every event of the project
adminlyr_adm_Secret: reads and manages the project through the API (Full access in the dashboard)
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

Makes a key. Owners only. Its secret is printed once, because only a hash of it is kept.

lyrelog keys create --type ingest --name "iOS app"
lyrelog keys create --type server --name tilefall-api --json | jq -r .secret
FlagWhat
--typeingest (default), server, read or admin
--nameWhere the key is used

A server, read or admin key needs a sign-in from the last 10 minutes. If yours is older, the command stops with "This needs a recent sign-in". Run lyrelog login, then create the key. A project has at most 20 active keys.

keys revoke

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

Revokes a key. Owners only. Whatever uses it stops working. It asks first; -y (--yes) skips the question, and JSON mode needs it.

Organizations

lyrelog orgs lists your organizations, your role in each and its plan. lyrelog orgs show lists one's people and open invitations.

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

The commands below are for owners. Each takes --org with an id or a name. Without it, they use your only organization, or the default project's.

CommandWhat
orgs rename <name>Rename the organization
orgs inviteMake an invitation link (7 days, works once). --role owner or member (default); --email emails it.
orgs revoke-invite <invite-id>Cancel an open invitation
orgs role <member> <owner|member>Change someone's role. The member is their email or user id.
orgs remove <member>Remove someone. Anyone can remove themselves, to leave. Asks first; --yes skips it.
lyrelog orgs invite --role member --email ana@example.com
lyrelog orgs role ana@example.com owner

An invitation's link is printed once. Anyone holding it can join the organization with that role. An organization always keeps an owner, so a change that would leave it without one is refused.

Account

lyrelog account shows your account as the account page does: your email, passkeys and two-step sign-in.

Alex Rivera alex@example.com

  Email            ✓ confirmed
  Passkeys         none
  Two-step         off
CommandWhat
account set --name <name>Change your name
account sessionsWhere you're signed in: browsers and computers with the CLI (not access tokens)
account sign-out <session-id>Sign one of those sessions out

Adding passkeys or sign-in methods and turning on two-step sign-in happen in the browser (lyrelog open account). See Sign in for sessions.

Access tokens

An access token (lyr_tok_...) lets CI or a script use the CLI or the API as you, through LYRELOG_TOKEN (see Scripts and CI). The account page's Access tokens does the same as these commands.

lyrelog tokens (or tokens list) lists yours:

Name                    ID  Expires      Last used
GitHub Actions, deploy  45  Feb 3, 2027  1h ago
nightly export          46  ⚠ never      Oct 1
CommandWhat
tokens create --name <name>Make a token. --expires 30d, 90d (default), 1y or never. It's printed once.
tokens expiry <id> --expires <when>Change when it expires, counted from now: 30d, 90d, 1y or never
tokens revoke <id>Revoke it. Whatever uses it stops working. Asks first; -y (--yes) skips it.
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.

Making a token, and making one last longer or never expire, need a sign-in from the last 10 minutes: right after lyrelog login. Otherwise the command stops with "This needs a recent sign-in" (exit 4). Making one shorter works any time. An access token can't make or change tokens, so these commands refuse to run with LYRELOG_TOKEN set to one (exit 5, browser_only).

A token that never expires gets a warning, and in JSON mode --expires never needs --yes. In JSON mode, tokens create prints {"token","session","never_expires"}:

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