リファレンス
コマンドラインツールのグローバルフラグ、環境変数、設定ファイル、シェル補完、バージョン。
グローバルフラグ
どのコマンドでも使えます。
| フラグ | 内容 |
|---|---|
-p, --project | プロジェクト:ID、slug、名前。デフォルトは lyrelog use で選んだもの。 |
--url | ダッシュボードのアドレス。デフォルトは https://app.lyrelog.com、または LYRELOG_URL。 |
--json | ターミナルでも JSON を出力します |
--human | パイプに渡すときでもテーブルと色で出力します |
--no-color | 色なし(NO_COLOR=1 でも同じ) |
-h, --help | コマンドのヘルプ(例付き) |
環境変数
| 変数 | 内容 |
|---|---|
LYRELOG_TOKEN | アクセストークン(lyr_tok_...、lyrelog tokens create またはアカウントページで作成)か、CLI のセッショントークン。保存されたサインインより優先されます。スクリプトと CIを参照してください。 |
LYRELOG_URL | ダッシュボードのアドレス。--url のほうが優先されます。 |
LYRELOG_CONFIG_DIR | 設定ファイルを置くフォルダー |
LYRELOG_THEME | dark または light。ターミナルの背景の判定が間違っているときに使います |
LYRELOG_AGENT | 任意の値:コーディングエージェントの場合と同じく JSON を出力します |
NO_COLOR | 任意の値:色なし |
BROWSER | lyrelog login と lyrelog open が使うブラウザー。ブラウザーを使わないなら none |
JSON とテーブルのどちらにするかを決めるため、ツールはコーディングエージェントや CI が設定する変数も読みます。JSON かテーブルかを参照してください。
設定ファイル
ツールは設定を 1 つの JSON ファイル config.json に保存します。場所は次のとおりです。
| フォルダー | |
|---|---|
| macOS と Linux | ~/.config/lyrelog。$XDG_CONFIG_HOME/lyrelog が設定されていればそちら |
| Windows | %AppData%\lyrelog |
| どこでも | 設定されていれば LYRELOG_CONFIG_DIR |
ファイルは本人しか読めず(0700 のフォルダー内でモード 0600)、一度に書き込まれるので、書きかけのまま残ることはありません。中身は次のとおりです。
| フィールド | 内容 |
|---|---|
url | --url も LYRELOG_URL も指定がないときに使うサーバー。最後にサインインしたサーバーです |
hosts | サーバーごとに 1 つのエントリー。アドレスがキーになります |
hosts.*.token | セッション。ツールがこれを表示することはありません。 |
hosts.*.expires_at | セッションが遅くとも終わる時刻(Unix 秒) |
hosts.*.user_email, hosts.*.user_name | 誰のものか |
hosts.*.project, hosts.*.project_name | デフォルトのプロジェクトの ID と、メッセージ用のその名前 |
{
"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"
}
}
}トークンはブラウザーの Cookie のようなセッションです。コピーした人は、それが終わるまであなたとして操作できます。lyrelog logout はサーバー上でセッションを終了し、ファイルから削除します。
終了コード
0 は成功です。それ以外は何が起きたかを表します(2 はフラグの誤り、3 は未サインイン、4 は最近のサインインが必要、6 は見つからない、など)。一覧はエージェントとスクリプト向けにあります。
シェル補完
lyrelog completion は、bash、zsh、fish、powershell 用の補完スクリプトを出力します。置き場所はそれぞれの --help に書かれています。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補完を使うには、~/.zshrc に autoload -U compinit; compinit が必要です。その後、新しいシェルを起動してください。
バージョン
lyrelog versionlyrelog v0.1.0 (4678ef1, built 2026-11-19, go1.27.4, darwin/arm64)バージョン(リリースのもの、または go install が取得したもの)、ビルドがわかっていればコミットとビルド日、そしてビルドに使った Go のバージョンと対象のシステムを表示します。バージョンのないビルドでは dev と表示されます。JSON では {"version","commit","date","go","os","arch"} です。