algobot-cli

Algobot CLI

Algolia Agent Studio は、AI エージェントを構築するための Algolia のプラットフォームです。RAG システム、会話型エクスペリエンス、生成 AI コンテンツの作成を、Algolia の検索とレコメンデーションを検索基盤として実現できます。algobot（npm install -g algobot-ai）は、エージェントの作成、テスト、デプロイに使う CLI です。

Algobot とほかのツールの使い分け

必要なこと	使用するツール
Algolia 上での AI エージェントの構築・管理（RAG、チャットボット、生成 AI UI）	algobot-cli（このスキル）
Algolia の検索インデックス操作（レコード、設定、同義語）	algolia-cli
検索クエリ、分析、レコメンデーション	algolia-mcp

セットアップ

npm install -g algobot-ai
algobot init                    # Interactive wizard (creates first agent + profile)

または、プロファイルを手動で追加します（CI 対応、非対話型）：

algobot profiles add --name prod --env prod

非対話型モード（エージェントにとって重要）

非 TTY 環境（CI、スクリプト、エージェントのサブプロセス）では TUI を描画できません。 代わりに次を使用してください。

algobot ask "What is your return policy?"                    # One-shot
algobot interactive --text "hello ||| list my orders ||| /context"  # Multi-turn
algobot agents list --jq '.[] | .name'                       # JSON filtering

--jq は組み込みのため、jq を別途インストールする必要はありません。

主なコマンド

エージェント管理

algobot agents list
algobot agents get <agent-id>
algobot agents create --name "Support Bot" --model gpt-4o
algobot agents update <agent-id> --name "New Name"
algobot agents publish <agent-id>
algobot agents unpublish <agent-id>
algobot agents delete <agent-id>
algobot agents copy <id> --from-env dev --to-env prod

エージェントとのチャット

algobot ask "Find wireless headphones under $100"
algobot --profile staging ask "hello"        # Target specific environment
algobot --verbose ask "debug this"           # Show full HTTP traces

プロファイル／環境管理

algobot profiles list
algobot profiles add --name dev --env dev
algobot profiles setdefault prod
algobot --profile prod agents list
algobot --env dev agents list

コードとしての設定ワークフロー

Mustache テンプレートを使ってエージェント定義をバージョン管理します。イベント、チーム、環境をまたいだ再現可能なデプロイに最適です。

# 1. Scaffold from an existing agent
algobot agents scaffold <agent-id>           # → agent-config.json + PROMPT.md

# 2. Preview (API-level kill switch — mutations blocked by construction)
algobot --dry-run agents create --config agent-config.json --var event="Spring 2026"

# 3. Deploy
algobot agents create --config agent-config.json --var event_name="Spring 2026"

# 4. Update + publish in one step
algobot agents update <id> --config agent-config.json --var event_name="Summer 2026" --publish

JSON フィールド内の {{key}}：JSON セーフなエスケープ。.md の指示内：そのまま置換。

Agent Studio の機能（エージェント設定で利用可能）

基本的なチャット以外に、Agent Studio のエージェントでは次の機能を利用できます。

• ツール：Algolia Search、Algolia Browse、Algolia Recommend、クライアントサイドのツール、および MCP ツール（Algolia と連携して、CRM、在庫管理システム、外部 API に接続）。algobot tools list/add/remove で管理します
• メモリ：algolia_memorize、algolia_ponder、algolia_memory_search ツールを使用して、セッションをまたいだ意味記憶（事実／好み）とエピソード記憶（過去のやり取り）を利用します。エージェント設定で検索モード（preload または preflight）を設定します。
• 会話の保存：保持期間を設定できる永続的な履歴。エクスポート／削除には algobot conversations を参照してください
• 実験的機能：回答への引用マーカー [1][2]、日付の挿入、回答のキャッシュ。エージェント設定で有効にします

algobot agents scaffold を使用してこれらの設定を確認・編集し、適用前のプレビューには algobot --dry-run を使用してください。

ライブ開発

algobot agents watch patch.json             # Auto-apply patches on file change

グローバルフラグ

フラグ	効果
--env dev|staging|prod|local	対象環境
--profile <name>	名前付きプロファイルを使用
--dry-run	変更を加えずにプレビュー（API によって強制）
--verbose	HTTP ログをすべて表示
--jq '<expr>'	JSON 出力をフィルタリング
--confirm	exec ツールの確認をスキップ

注意点

• TUI には TTY が必要です。 引数なしで algobot を実行すると TUI が起動し、スクリプトでは処理が停止します。非対話型の環境では、必ず ask または --text を使用してください。
• v2.0 の終了コードは 0/1 のみです。「見つからない」と「認証エラー」を区別できません。必要に応じて stderr を解析してください。
• v2.0 では、ほとんどのコマンドで --output json を使用できません。 --jq または JSON 形式の stdout を使用してください。
• algobot init は対話型です。 CI では使用せず、代わりにフラグを指定して profiles add を使用してください。
• prod は EU ホストに解決されます。 v2.0.0 では 3 つの API ホストがハードコードされています。agent-studio.eu.algolia.com（prod）、agent-studio-staging.eu.algolia.com（staging）、conversational-ai-dev.algolia.com（dev）です。リージョンフラグはなく、読み込まれる環境変数は ALGOLIA_APP_ID、ALGOLIA_APPLICATION_ID、ALGOLIA_API_KEY、ALGOLIA_AGENT_ID のみです。いずれもホストを上書きしません。アプリのエージェントが EU にない場合、稼働中で補完を提供しているエージェントでも、agents list は [] を返し、agents get <id> は 404 を返します。管理者 API キーを使用しても変わりません。認証情報に問題があると判断する前に、algobot --verbose agents list でホストを確認してください。
• 認証情報は ~/.algobot-cookie ではなく、~/.algobot-profiles に暗号化して保存されます。 v2.0 では algobot auth show は削除されています。algobot profiles list、または詳細を確認するには algobot profiles show <name> を使用してください。profiles show は API キーを平文で表示するため、共有ターミナル、画面共有、ログでは使用しないでください。
• --config はカレントディレクトリ内の agent-config.json を自動検出します。 明示的に指定する場合は、--config path/to/config.json を使用してください。
• algobot は開発／デプロイ用ツールで、本番環境での呼び出しには REST API を使用します。 algobot でエージェントを作成して公開し、アプリから Agent Studio completions API を直接呼び出してください。エンドポイント URL を推測せず、algobot agents get <id> を実行して取得するか、Agent Studio ダッシュボードを確認してください。
• Completions URL に /agent-studio のプレフィックスはありません。 agent-studio.<region>.algolia.com/1/agents/<id>/completions?stream=false&compatibilityMode=ai-sdk-4 を使用してください。compatibilityMode は必須です（省略すると 422）。レスポンスは { id, role, content } で、content はフラットな文字列です。
• agents create --provider <name> はプロバイダーをリンクしません。 エージェントは draft のままとなり、公開時に 409 が返されます。作成後、algobot agents patch <id> --json patch.json を実行し、{"providerId": "<uuid>"} を指定してから公開してください。

リファレンスドキュメント

• コマンドリファレンス — 各コマンドの全フラグ
• Config-as-Code ガイド — テンプレート、変数、複数環境のパターン