アーリーアクセス招待制です。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プロジェクトの名前
--slugURL 用の短い名前:小文字の英字、数字、ダッシュ
--org組織を ID か名前で指定。デフォルトは、所属する唯一の組織か、デフォルトのプロジェクトの組織。

projects platform

プロジェクトを構成するプラットフォームを、詳細とともに 1 つ追加または削除します。オーナーのみです。

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:Web サイトのアドレス
--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 を実行してから、キーを作ってください。1 つのプロジェクトで有効なキーは最大 20 個です。

keys revoke

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

キーを失効させます。オーナーのみです。そのキーを使っているものはすべて動かなくなります。事前に確認を求めます。-y(--yes)で確認を省略でき、JSON モードではこれが必要です。

組織

lyrelog orgs は、所属する組織を、それぞれでの自分のロールとプランとともに一覧します。lyrelog orgs show は、1 つの組織のメンバーと未使用の招待を一覧します。

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 日間有効、1 回限り)。--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 は、アカウントページと同じようにアカウントを表示します。メールアドレス、パスキー、2 段階認証です。

Alex Rivera alex@example.com

  Email            ✓ confirmed
  Passkeys         none
  Two-step         off
コマンド内容
account set --name <name>名前を変更します
account sessionsサインインしている場所:ブラウザーと、CLI を使っているコンピューター(アクセストークンは含みません)
account sign-out <session-id>それらのセッションの 1 つをサインアウトさせます

パスキーやサインイン方法の追加と、2 段階認証の有効化はブラウザーで行います(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