抢先体验仅限邀请,SDK 尚未发布。申请邀请
跳到正文
文档

项目、密钥和组织

在终端中选择项目、更改项目设置、创建和吊销密钥、邀请成员以及查看你的账户。

更改设置、密钥和成员的方式与控制台中相同,规则也相同。只有所有者能做的事,仍然只有所有者能做。创建服务器密钥、只读密钥或管理密钥需要 近期登录。任何无法撤销的操作都会先询问。

删除项目或账户,以及更改登录方式,只能在控制台中进行(参见删除项目和删除账户)。 Lyrelog 会拒绝来自 CLI 的这些操作,即使通过 lyrelog api 也不行,返回 403 和 "browser_only": true。

项目

lyrelog projects 列出你能看到的项目,以及它们最近 24 小时的事件数、用户数和错误数,和控制台的项目切换器一样。

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

任何命令都接受 -p(--project),取值可以是项目的 slug、名称或 id(控制台地址中的那 12 个字符)。

use

选择在未指定 -p 时命令使用的项目。它按服务器保存在配置文件中。

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

projects show

显示项目的设置。传入一个项目,否则显示默认项目。

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

更改项目的设置,与项目的设置页面作用相同。仅限所有者。只有你传入的参数才会改变。 列表会替换原有内容,"" 会清空它。

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
参数作用
--name项目名称
--retention-days事件保留的天数,不超过套餐允许的上限(参见保留期限)
--default-env控制台默认打开的环境(all 表示全部环境)
--people项目对用户的称呼,格式为 singular,plural:player,players
--platform项目主要是什么:ios、android、web、api 或 other
--platforms项目由哪些部分组成:ios、android、macos、web、api,用逗号分隔
--require-verified只接受已验证事件的平台;"" 表示接受所有事件
--attest-app-ids项目中的应用通过 Apple App Attest 证明身份时使用的 App ID(TEAMID.bundle.id);"" 表示关闭

projects create

在你的某个组织中创建项目。仅限组织所有者。它会输出项目的第一个采集密钥,只显示一次:把它放进你的应用。

lyrelog projects create --name "Tilefall web" --slug tilefall-web
参数作用
--name项目名称
--slug用于 URL 的短名称:小写字母、数字和连字符
--org组织,按 id 或名称指定。默认:你唯一的组织,或默认项目所属的组织。

projects platform

添加或移除项目所包含的某个平台及其详情。仅限所有者。

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
参数作用
--urlweb:网站的地址
--packageandroid:Google Play 包名
--runtimeapi:服务器使用的语言

平台有 ios、android、macos、web 和 api。

密钥

lyrelog keys(或 keys list)列出项目的 API 密钥,包括已吊销的。类型与密钥中的相同:

类型前缀说明
ingestlyr_ing_公开且只能写入:随你的应用一起发布
serverlyr_srv_机密:从你的服务器发送已验证事件
readlyr_read_机密:读取项目的每一个事件
adminlyr_adm_机密:通过 API 读取和管理项目(控制台中称为 Full access)
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

创建密钥。仅限所有者。密钥只输出一次,因为服务器只保存它的哈希。

lyrelog keys create --type ingest --name "iOS app"
lyrelog keys create --type server --name tilefall-api --json | jq -r .secret
参数作用
--typeingest(默认)、server、read 或 admin
--name密钥用在哪里

server、read 或 admin 密钥需要最近 10 分钟内的登录。如果你的登录更早,命令会停止并提示“This needs a recent sign-in”。 请运行 lyrelog login,然后再创建密钥。一个项目最多有 20 个有效密钥。

keys revoke

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

吊销密钥。仅限所有者。任何使用它的地方都会停止工作。它会先询问;-y(--yes)跳过询问,JSON 模式下必须加上它。

组织

lyrelog orgs 列出你的组织、你在每个组织中的角色及其套餐。lyrelog orgs show 列出某个组织的成员和尚未接受的邀请。

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

下面的命令供所有者使用。每条命令都接受 --org,取值为 id 或名称。不指定时,使用你唯一的组织,或默认项目所属的组织。

命令作用
orgs rename <name>重命名组织
orgs invite生成邀请链接(7 天有效,只能使用一次)。--role owner 或 member(默认);--email 会通过邮件发送它。
orgs revoke-invite <invite-id>取消一个尚未接受的邀请
orgs role <member> <owner|member>更改某人的角色。成员用其邮箱或用户 id 指定。
orgs remove <member>移除某人。任何人都可以移除自己,以退出组织。会先询问;--yes 跳过询问。
lyrelog orgs invite --role member --email ana@example.com
lyrelog orgs role ana@example.com owner

邀请链接只输出一次。任何持有它的人都能以该角色加入组织。组织必须始终有一个所有者,所以会导致组织没有所有者的更改会被拒绝。

账户

lyrelog account 像账户页面一样显示你的账户:邮箱、通行密钥和两步验证。

Alex Rivera alex@example.com

  Email            ✓ confirmed
  Passkeys         none
  Two-step         off
命令作用
account set --name <name>更改你的名字
account sessions你在哪些地方登录了:浏览器和使用 CLI 的电脑(不含访问令牌)
account sign-out <session-id>让其中某个会话退出登录

添加通行密钥或登录方式、开启两步验证,都在浏览器中进行(lyrelog open account)。关于会话,参见 登录。

访问令牌

访问令牌(lyr_tok_...)让 CI 或脚本可以通过 LYRELOG_TOKEN 以你的身份使用 CLI 或 API(参见 脚本和 CI)。账户页面的 Access tokens 与这些命令的作用相同。

lyrelog tokens(或 tokens list)列出你的令牌:

Name                    ID  Expires      Last used
GitHub Actions, deploy  45  Feb 3, 2027  1h ago
nightly export          46  ⚠ never      Oct 1
命令作用
tokens create --name <name>创建令牌。--expires 30d、90d(默认)、1y 或 never。只输出一次。
tokens expiry <id> --expires <when>更改过期时间,从当前时间起算:30d、90d、1y 或 never
tokens revoke <id>吊销它。任何使用它的地方都会停止工作。会先询问;-y(--yes)跳过询问。
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.

创建令牌,以及把令牌的有效期延长或改为永不过期,需要最近 10 分钟内的登录:也就是刚运行完 lyrelog login 时。 否则命令会停止并提示“This needs a recent sign-in”(退出码 4)。缩短有效期随时都可以。访问令牌不能创建或更改令牌, 所以当 LYRELOG_TOKEN 设为访问令牌时,这些命令会拒绝运行(退出码 5,browser_only)。

永不过期的令牌会显示警告,在 JSON 模式下 --expires never 需要加上 --yes。在 JSON 模式下,tokens create 输出 {"token","session","never_expires"}:

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