メインコンテンツへスキップ
AgentEye CLI(agenteye)は、AgentEyeデプロイメント向けのターミナルクライアントです。データ(セッション、イベントログ、評価)の照会と、組織の管理(APIキー、ユーザー、設定、アラート、インシデント、保存済みクエリ)を行います。ダッシュボードで実行できることはすべて、スクリプトやコーディングエージェントからも実行できます。すべてのコマンドは --json フラグに対応しており、ターミナルで作業する人間にも、結果をパースするコーディングエージェント(Claude Code、Cursor)にも同様に使用できます。
これは agenteye CLI であり、コレクターデーモン(agenteye-collector)とは異なるツールです。CLIはお使いのダッシュボードと通信し、コレクターはサーバーにイベントを送信します。コレクターについては コレクターのインストール を参照してください。

インストール

CLIはパブリックのPyPIに agenteye として公開されています。AgentEyeのPython SDKも agenteye というディストリビューション名を使用しているため、CLIは独立した環境(pipx または uv tool)にインストールして、同一の仮想環境で両者が競合しないようにしてください。
Python SDKを同じ環境にインストールしない場合は、通常の pip install agenteye でも動作します。CLIにはPython 3.10以上が必要で、GitHubトークンは不要です。パブリックパッケージです。 インストールされるコマンドは agenteye です。

認証

CLIは、メールで送信されるワンタイムコードを使用してダッシュボードに認証します。
セッショントークンは ~/.agenteye/cli.json(本人のみ読み取り可能、モード 0600)に保存され、デフォルトで24時間有効です。期限が切れたら、agenteye login を再度実行してください。
whoami はセッションが存在しない場合や期限切れの場合にエラーを返しません。代わりに logged_in: false を報告するため、スクリプトやエージェントが認証状態を安全に確認できます(ベースURLが設定されていない場合やダッシュボードに到達できない場合は、ゼロ以外の終了コードを返すことがあります)。 前提条件: あなたのメールアドレスがダッシュボードへのサインインを許可されている必要があります(AgentEye管理者に確認してください)。また、ダッシュボードはそのベースURLで到達可能である必要があります(設定を参照)。コードをリクエストしても届かない場合、そのメールアドレスはまだダッシュボードアクセスが有効化されていない可能性があります。

組織の選択(マルチテナント)

アカウントが複数の組織に所属している場合、ログイン時にアクティブな組織を選択してください。選択内容が保存され、以降のすべてのコマンドに使用されます。
1つの組織にのみ所属している場合は自動的に選択されるため、--org は不要です。複数の組織に所属していて選択しない場合、CLIが一覧を表示して --org <slug> で再実行するよう求めます。アクティブな組織はすべてのリクエストでダッシュボードに送信され、権限は組織ごとに解決されます。agenteye whoami はアクティブな組織、その中での権限、およびすべてのメンバーシップを表示します。

設定

設定フラグ環境変数デフォルト
ダッシュボードのベースURL--base-urlAGENTEYE_DASHBOARD_URL必須(デフォルトなし)
アクティブな組織/テナント--orgAGENTEYE_ORGログイン時に選択、~/.agenteye/cli.json に保存
セッショントークン--tokenAGENTEYE_CLI_TOKEN~/.agenteye/cli.json から読み込み
JSON出力--jsonAGENTEYE_CLI_JSONオフ
TLS検証のスキップ--insecure / --secureAGENTEYE_INSECUREオフ(ログイン時に保存)
リクエストタイムアウト(秒)--timeout30
利用状況テレメトリーの無効化(なし)AGENTEYE_ANALYTICS_DISABLED(または DO_NOT_TRACKオフ(テレメトリー有効)
解決順序は フラグ → 環境変数 → 設定ファイル です。デフォルト値はありません。CLIをダッシュボードに向ける必要があります。コマンドごとに指定する(--base-url https://agenteye.example.com)か、環境変数で一度設定してください(最初の login 後にも保存されます)。
設定ディレクトリは AGENTEYE_HOME を優先します(SDKおよびコレクターと同じ規約)。設定されている場合、cli.json$AGENTEYE_HOME/cli.json に配置されます。

自己署名または内部TLS

ダッシュボードが自己署名または内部証明書(例:ロードバランサーの生のホスト名)を使用したHTTPSで提供されている場合、TLS検証は CERTIFICATE_VERIFY_FAILED エラーで拒否されます。証明書検証をスキップするには --insecure を使用してください。
--insecure はログイン時に cli.json に保存されるため、以降のコマンドは自動的に検証をスキップします。フラグを繰り返す必要はありません。検証付きで一度だけ呼び出すには --secure を使用するか、次回ログイン時に検証を有効に戻すために使用してください。検証が無効になっている状態でダッシュボードに接続するコマンドを実行する前に、CLIはstderrに警告を表示します。検証をスキップすると中間者攻撃からの保護が失われます。ダッシュボードへのネットワークパス(VPN、プライベートサブネットなど)を信頼できる場合のみ使用してください。

テレメトリーとプライバシー

CLIはExosphereの分析サービス(PostHog)に匿名の利用状況分析を送信します。実行されたコマンド(例:sessionskeys create)、成否、所要時間が含まれます。この利用状況シグナルは、どの機能を優先するかを決定するために使用されます。
  • エージェント、セッション、イベントデータはお客様のインフラストラクチャの外に出ることはありません。 送信されるのはCLIの利用状況のみです。コマンドとサブコマンド名(例:keys create)、使用したフラグの名前(値は含まれません)、成功/終了ステータス、所要時間、およびミューテーション操作のイベント(例:api_key_createdquery_run)。このイベントには静的な名前/列挙値と大まかなカウントのみが含まれます。ダッシュボードのURL、セッショントークン、メールアドレス、組織スラッグ、リソースID、SQL、キーシークレット、クエリフィルターは一切送信されません。オペレーターは不透明な内部IDによってのみ識別され、メールアドレスは使用されません。
  • テレメトリーはデフォルトで有効です。無効にするには、CLIの環境変数に AGENTEYE_ANALYTICS_DISABLED=1 を設定してください(ツール共通の DO_NOT_TRACK=1 規約も有効です)。
  • CLIはPostHog(https://us.i.posthog.com)に直接送信します。CLIを実行するマシンはそのホストへのアウトバウンドアクセスが必要です。ブロックされている場合、テレメトリーは無音で何もしません(送信には時間制限があるため、コマンドの遅延や障害は発生しません)。CLIの動作には影響しません。

グローバルオプションと規約

一度お読みください。すべてのコマンドに適用されます。
  • グローバルオプションはコマンドの前に指定します。 agenteye --json sessions が正しい形式です。agenteye sessions --json は使用エラーです。グローバルオプションは --json--base-url--org--token--insecure/--secure--timeout--quiet--no-color です。
  • --json は純粋なJSONのみをstdoutに出力します。 人間向けのステータス行、警告、エラーはすべてstderrに出力されるため、ステータス行が表示されていても --json のstdoutキャプチャは jq にパイプできる状態を保ちます。--json なしの場合は、人間が読みやすいボックス形式でカラー表示されます。
  • --help で詳細を確認できます。 すべてのコマンドとサブコマンドには --help(および -h エイリアス)があります:agenteye -hagenteye sessions -hagenteye keys create -h。トップレベルのヘルプには終了コードとグローバルオプションも記載されています。グローバルなマシン可読サーフェスダンプはありません。コマンドごとの --help と、2つのレジストリ専用の agenteye query schemaagenteye settings schema を使用してください。
  • スクリプトとエージェントでは確認プロンプトが自動スキップされます。 作成/更新/削除コマンドはインタラクティブなターミナルで確認を求めますが、--json フラグが指定されている場合やstdinがTTYでない場合は自動スキップされるため、スクリプトやエージェントがハングすることはありません。明示的にスキップするには --yes/-y を使用してください。エージェントでプロンプトは表示されないため、エージェントは破壊的な操作を行う前に人間に確認を取るべきです。
  • ページネーション: 結果は新しい順にカーソルページネーションされます。--limit N(エイリアス -n)は行数を制限し、デフォルトは50です。--all は自動ページネーション(200行ずつ)を行いますが、--limit までで停止します。つまり、--all 単独でも50件で止まります。完全な取得には高い上限を明示的に指定してください:--all --limit 1000--page-size N はリクエストごとのチャンクを制御します(最大200)。--cursor <id> は前のページの next_cursor から再開します。
  • 時間フィルター: --since は相対的なウィンドウを受け取ります — 15m1h6h24h7d30d、または all(ダッシュボードのプリセット)。--from/--to はカスタム範囲用に明示的なISO-8601 UTCタイムスタンプ(T とタイムゾーン付き、例:2026-06-01T00:00:00Z)を受け取り、--since を上書きします。スペース区切りやタイムゾーンなしの値は使用エラーになります。
  • --fields a,b,ceventssessionsevalserrors で使用可能)は出力をそれらのキーに制限します。テーブルと --json の両方に適用されます。不明なフィールド名は有効なリストとともにエラーとして拒否されます。フィールド名を調べる簡単な方法として活用できます。
  • --file payload.json(または --file - でstdinから読み込み)は、リソースが複雑な形状を持つ場合にJSON形式のリクエストボディ全体を提供します。alerts create/updatesettings setusers create/update で使用できます。保存済みクエリのSQLには --sql @file.sql を使用します。
  • 複数値フィルターはカンマ区切りで、集合として照合されます(同一フィルター内ではOR、フィルター間ではAND):--event-type tool_use,tool_result。Clickオプションは可変長ではないため、--add a b は機能しません。--add a,b、フラグの繰り返し(--add a --add b)、またはクォート(--add "a b")を使用してください。

コマンドリファレンス

CLIには18のトップレベルコマンドがあります。すべての読み取りコマンドは --json とグローバルオプションに対応しています。詳細なフラグリストや任意のコマンドのJSON形式については agenteye <command> -h(または <command> <subcommand> -h)を実行してください。

Identity — login · logout · whoami · orgs · version · help

orgs はアクティブなテナントの確認と切り替えを行います。

観察(読み取り専用) — events · sessions · evals · errors · list

これらはいずれも確認を必要としません。共有フィルター:--session-id--agent-id--env--environment ではありません)、および時間範囲(--since / --from / --to)。
--score KEY:MIN..MAXevals のみ、sessions では使用不可)は繰り返し指定可能でAND結合されます。どちらの境界も省略可能(..0.5 は ≤ 0.5、0.9.. は ≥ 0.9)。リクエストあたり最大20のスコアフィルター。evals --scores-full はサマリーではなく完全なスコアオブジェクトを返します。1つのセッション全体を読むには、イベントトレイルと評価を組み合わせます。

管理(権限が必要) — keys · users · settings · alerts · incidents

keys — APIキー。シークレットはローカルで生成されてサーバーに送信され(サーバーはハッシュのみを保存)、作成/再生成時に一度だけ表示されます。その場でキャプチャしてください。--json の場合は key フィールドにのみ表示されます。名前で参照します。
権限は (permission-set ∪ --add) − --remove として機能します。トークンは slug:action(例:events:read)または slug:action.action(1つのリソースで複数のアクションを展開、例:events:read.addevents:readevents:add)の形式です。プリセット:read-onlystandardadmin。人間のみの権限(keys:update)はキーに付与できません。 users — 組織メンバー。メールアドレス(UUIDのidも使用可能)で参照します。
settings — 固定レジストリです(既存のキーの読み取りと変更のみ可能、新規作成は不可)。
alerts — アラート定義。名前で参照します。create は位置引数のNAMEとフラグ、または --file でJSON形式のボディを受け取ります。
incidents — アラートインシデント。idで参照します(短いidも使用可能)。show は完全なアクティビティログを表示します。操作前に必ず確認してください。

分析とアシスタント — query · agent

query — 保存済みClickHouse SQLとアドホック実行ツール。保存済みクエリは名前で参照します。SQLはサーバー側で検証されます(SELECT/WITHのみ、ステートメントタイムアウト、行数上限あり)。
agent — ダッシュボード組み込みのアシスタント(ダッシュボードでチャットできる読み取り専用のアナリストと同じ)。チャットは短いchat-id(プレフィックス解決あり)で参照します。

終了コード

コード意味
0成功
1予期しないエラー(例:ダッシュボードが5xxを返した)
2使用エラー(無効な引数、不明なコマンド/フラグ、名前の競合)
3ダッシュボードに到達できない
4ログインしていないかセッションが期限切れ;agenteye login を実行してください
5認証済みだが、アカウントに必要な権限がない(メッセージに権限名が表示されます)
6指定されたリソースが見つからない(例:不明なセッションIDまたはインシデントID)
これらの終了コードによりCLIはスクリプト内で安全に使用できます。コーディングエージェントは 4 を受け取って再認証を促したり、5 で不足している権限を通知したりできます。終了コードの処理パターンとJSON出力の形式については、エージェント向けCLIレシピ を参照してください。

参考情報

  • エージェント向けCLIレシピ — コピーして使えるクエリパターン、jq ワンライナー、--fields プロジェクション、終了コード処理、JSON出力形式。CLIを操作するコーディングエージェント向けに書かれています。
  • AgentEye CLI skill — このCLIをインストール可能な Claude Code / Codex スキルとしてパッケージ化し、コーディングエージェントが平易な英語のリクエストでAgentEyeを操作できるようにします。
  • APIキーkeys create --add … の背後にある権限モデル。
  • AIアシスタントagent ask が使用するアシスタントの有効化方法。