> ## Documentation Index
> Fetch the complete documentation index at: https://docs.befailproof.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI

> FailproofAI Observability CLI のドキュメント。

FailproofAI Observability のデプロイ全体を、コマンド一つで管理できます。ターミナルを離れることなく、本番環境の確認・APIキーの発行・インシデントの承認が可能です。さらに、CI に組み込んでスクリプト化したり、コーディングエージェントに自然言語で操作させることもできます。

```bash theme={null}
pipx install agenteye
agenteye login --email you@example.com      # 6桁のコードがメールで届きます
agenteye --json sessions --since 24h         # 過去24時間のエージェント実行一覧（新しい順）
```

*`agenteye` CLI はダッシュボードと通信します。これはサーバーにイベントを送信するコレクターとは別のツールです。*

## デプロイ全体をコマンド一つで管理

簡単な疑問を解消するためにタブを切り替える必要はもうありません。`agenteye` CLI は単一のバイナリでデータの参照と組織の管理を行えるため、ダッシュボードをクリックしていた確認作業が、再実行・エイリアス登録・ランブックへの貼り付けが可能な一行のコマンドになります。以下の4つの機能を提供します。

* **データの参照：** `sessions`、`events`、`evals`、`errors` を時間・エージェント・環境でフィルタリング。
* **組織の管理：** `keys`、`users`、`settings`、`alerts`、`incidents` の管理。
* **アナリティクスの実行：** 保存済みSQLと、イベントデータに対するアドホックな `query` ランナー。
* **アシスタントへの質問：** `agent ask` でダッシュボード上の読み取り専用アナリストと同じ機能を利用。

`pipx` で一度インストールし、メールで届く6桁のコードでサインインすれば準備完了です。セッションは約1日間有効で、期限切れになったら `agenteye login` を再実行してください。ブラウザを開かずに、本番環境のスポットチェック・キーの発行・発火中インシデントのトリアージを行えます。

```bash theme={null}
agenteye errors --since 24h --aggregate      # エラータイプ別にグループ化した障害状況
agenteye incidents list --state firing       # 現在発火中のインシデント
agenteye keys create ci --add events:add     # イベントのプッシュのみ可能なキー（シークレットは一度だけ表示）
```

一つ覚えておきたい習慣として、`--json` などのグローバルオプションはコマンドの前に記述します。`agenteye --json sessions` が正しく、`agenteye sessions --json` は誤りです。

## スクリプト化してCIに組み込む

すべてのコマンドで `--json` が使用でき、これにより大きく使い勝手が変わります。クリーンなJSONが stdout に出力され、人向けのステータスや警告は stderr に送られます。そのため、`--json` の出力は余計な行を除去することなく、そのまま `jq` にパイプできます。これにより、CLIはターミナルでの対話的な使用にも、出力を解析するコーディングエージェントにも同様に適した作りになっています。

```bash theme={null}
agenteye --json sessions --since 24h --status error | jq -r '.sessions[].session_id'
```

無人実行を前提に設計されています。端末が接続されていない場合、確認プロンプトは自動的にスキップされるため、パイプラインで処理が止まることはありません。また、すべてのコマンドは意味のある終了コードを返します。`0` は成功、`4` は未ログイン、`5` はパーミッション不足（メッセージに `alerts:write` などの具体的な権限名が表示されます）、`3` はダッシュボードに到達不能。スクリプトは `4` で再認証に分岐したり、`5` で管理者に何を依頼すべきかを正確に伝えたりでき、原因不明の失敗を防げます。

## コーディングエージェントに自然言語で操作させる

さらに良いことに、これらのフラグをすべて覚える必要はありません。**CLIスキル**は `agenteye-cli` という小さなAgent Skillフォルダーで、Claude Code や Codex などのコーディングエージェントに自然言語のリクエストからCLIを操作させる方法を教えます。「今日、何か問題が起きていますか？」と尋ねるだけで、エージェントが適切なコマンドを選択し、あなたの権限で実行し、結果を文章で回答します。

Claude Code の場合、`agenteye-cli` フォルダーを `~/.claude/skills/` に配置するだけで自動検出されます。FailproofAI Observability がそのフォルダーを提供します。既にインストール済みのCLIを操作するだけなので、追加でインストールするものはありません。ただし、先にご自身でログインしておいてください。メールコードによるログインをスキルが代行することはできません。

エージェントはあなたの権限でCLIを実行するため、ログインで許可されているすべての操作（読み取りと書き込みの両方）が可能です。キーの作成・設定の変更・インシデントの解決も含まれます。CLIの確認プロンプトはエージェントに対しては表示されないため、スキルは変更を実行する前に正確なコマンドを提示し、あなたの承認を待つよう設計されています。確認ステップはあなた自身です。

```text theme={null}
you    セッション run-001 はなぜ失敗しましたか？

agent  実行中: agenteye --json events --session-id run-001 --all
       checkout-agent は3回目のツール呼び出しで TimeoutError が発生しました。
```

読み取りは即座に完了し、書き込みはすべてあなたの承認待ちで一時停止します。

```text theme={null}
you    CI にイベントのプッシュのみできるキーを発行してください。

agent  APIキーを作成します。以下を実行します:
         agenteye keys create ci --add events:add
       続行してよろしいですか？

you    はい

agent  完了しました。「ci」キーが events:add 権限のみで作成されました。シークレットは一度しか表示されないため、今すぐ保存してください。
```

## 関連リンク

* [CLIリファレンス](/ja/agenteye/cli): 全コマンド・フラグ・JSONの形式。
* [エージェント向けCLIレシピ](/ja/agenteye/cli-recipes): コピー&ペーストで使える `jq` パターンと終了コードの処理方法。
* [CLIエージェントスキル](/ja/agenteye/cli-skill): `agenteye-cli` スキルのインストールと使い方。
* [AIアシスタント](/ja/agenteye/assistant): `agent ask` が接続するダッシュボード内アナリスト。