api と open
lyrelog api は、サインインした状態でダッシュボードの任意の API ルートを呼び出します。lyrelog open は、ダッシュボードの同じページを開きます。
api
lyrelog api は、gh api のように、サインインした状態でダッシュボードの API の任意のルートを呼び出します。ほかのコマンドがまだ対応していない操作のためのものです。
lyrelog api <method> <path>- メソッドは
GET、POST、PUT、PATCH、DELETEのいずれかです。 - パスの
/apiは省略できます。projects/{project}は/api/projects/{project}と同じです。指定するのはパスだけです。サーバーは--urlまたはLYRELOG_URLで決まります。 {project}は、現在のプロジェクト(デフォルトのもの、または-p)の ID に置き換わります。
lyrelog api GET /api/me{"admin":false,"organizations":[{"id":4,"name":"Alex Rivera","role":"owner","plan":"free","plan_until":null}],"user":{"id":10,"email":"alex@example.com","name":"Alex Rivera"}}lyrelog api GET projects/{project}/regions -F from=1763500000000
lyrelog api PATCH projects/{project} --data '{"retention_days":30}'
lyrelog api POST projects/{project}/views --data @view.json| フラグ | 内容 |
|---|---|
-F, --field | key=value。GET ではクエリパラメーターに、POST、PUT、PATCH では JSON ボディのフィールドになります(数値、true、false、null はそのままの型で送られます)。複数指定するには繰り返します。 |
-d, --data | リクエストボディをそのまま指定します。JSON、ファイルを読むなら @file、stdin なら @-。-F とは併用できません。 |
レスポンスは届いたとおりに表示されます。ターミナルでは、JSON はインデントされ、色付きで表示されます。ボディのないレスポンスでは、ステータスが表示されます(JSON モードでは {"status":204})。失敗すると、ほかのコマンドと同じ終了コードで終了し、JSON モードでは stderr にエラーが JSON で出力されます。
これらはダッシュボード自身が使うルートで、ここでは説明していません。スクリプトからイベントを読むためのドキュメント化された API としては、読み取り API を使ってください。
open
lyrelog open は、現在のプロジェクトのダッシュボードのページをブラウザーで開きます。
lyrelog open errors
lyrelog open person gc-2e427d7b
lyrelog open settings --printhttps://app.lyrelog.com/p/e8bc11c6e22f/settings| ページ | 内容 |
|---|---|
| (なし) | エクスプローラー |
events | エクスプローラー |
errors | Errors ページ |
sessions | Sessions |
people | プロジェクトのユーザー |
insights | Insights |
releases | Releases |
keys | API keys |
settings | プロジェクトの設定 |
projects | すべてのプロジェクト |
usage | 使用量とプラン |
account | 自分のアカウント |
organization | 自分の組織 |
person <id> | 1 人のユーザーのページ |
event <id> | 1 件のイベントを検索した状態のエクスプローラー |
| フラグ | 内容 |
|---|---|
--print | 開く代わりにアドレスを表示します |
SSH 越しや、ブラウザーを開けない場合は、アドレスを表示します。JSON モード(エージェントやスクリプト向け)では何も開かず、{"url":"..."} を出力します。