algolia-cli

Algolia CLI

algolia CLI を使用して、ターミナルから Algolia の検索インフラストラクチャを管理します。

このスキルと algolia-mcp の使い分け

必要な操作	使用するもの
データの書き込み／変更（レコードのインポート、削除、更新）	algolia-cli（このスキル）
設定の管理（設定、ルール、同義語）	algolia-cli（このスキル）
認証（OAuth によるログイン、ログアウト、サインアップ）	algolia-cli（このスキル）
管理操作（API キー、プロファイル、インデックスのコピー／移動）	algolia-cli（このスキル）
インデックスのバックアップ／復元	algolia-cli（このスキル）
検索クエリと結果の表示	algolia-mcp
分析（人気の検索語、クリック率、検索結果なし）	algolia-mcp
レコメンデーション（関連商品、トレンド）	algolia-mcp

目安： データを読み取る、または分析する場合は algolia-mcp を使用します。データを変更、移動、または管理する場合は algolia-cli を使用します。

セットアップ

/algolia-cli:cli-setup を実行して CLI をインストールし、プロファイルを設定するか、はじめにに従ってください。

ヒント： algolia auth login は、認証情報を設定する最も簡単な方法です。OAuth サインインとプロファイルの作成を1つの手順で行えます。API キーをすでに持っている非対話型／CI 環境では、algolia profile add を使用してください。

コマンドクイックリファレンス

認証

タスク	コマンド
サインイン（ブラウザーを開く）	algolia auth login
サインイン（名前でアプリを選択）	algolia auth login --app-name "My App" --default
サインイン（ブラウザーなし／SSH）	algolia auth login --no-browser
サインアウト	algolia auth logout
新しいアカウントを作成	algolia auth signup

プロファイル

タスク	コマンド
プロファイルを追加（非対話型）	algolia profile add --name "default" --app-id "<ID>" --api-key "<KEY>" --default
プロファイルを一覧表示	algolia profile list
プロファイルを削除	algolia profile remove "<name>" -y
デフォルトのプロファイルを設定	algolia profile setdefault "<name>"

アプリケーション

タスク	コマンド
アプリケーションを一覧表示	algolia application list
アプリケーションを作成	algolia application create --name "My App" --region CA
作成（非対話型、ドライラン）	algolia application create --name "My App" --region CA --dry-run
アクティブなアプリケーションを切り替え	algolia application select --app-name "My App"

API キー

タスク	コマンド
API キーを一覧表示	algolia apikeys list
API キーを作成	algolia apikeys create --acl search,browse --description "..." --indices "idx1,idx2"
API キーを取得	algolia apikeys get <key>
API キーを削除	algolia apikeys delete <key> -y

検索

タスク	コマンド
インデックスを検索	algolia search <index> --query "<query>"
フィルターを指定して検索	algolia search <index> --query "<query>" --filters "<filter>"
ページネーション検索	algolia search <index> --query "<query>" --hitsPerPage 10 --page 2

インデックス

タスク	コマンド
すべてのインデックスを一覧表示	algolia indices list
インデックスを削除	algolia indices delete <index> -y
レコードをクリア（設定は保持）	algolia indices clear <index> -y
インデックスをコピー	algolia indices copy <src> <dst> -y
設定のみをコピー	algolia indices copy <src> <dst> --scope settings -y
インデックスを移動／名前変更	algolia indices move <src> <dst> -y

オブジェクト（レコード）

タスク	コマンド
すべてのレコードを閲覧	algolia objects browse <index>
指定した属性を閲覧	algolia objects browse <index> --attributesToRetrieve title,price
ファイルからレコードをインポート	algolia objects import <index> -F data.ndjson
標準入力からインポート	cat data.ndjson | algolia objects import <index> -F -
ID で削除	algolia objects delete <index> --object-ids id1,id2 -y
フィルターで削除	algolia objects delete <index> --filters "type:obsolete" -y
部分更新	algolia objects update <index> -F updates.ndjson

設定

タスク	コマンド
設定を取得	algolia settings get <index>
設定を変更	algolia settings set <index> --typoTolerance="false"
ファイルから設定をインポート	algolia settings import <index> -F settings.json
設定をインポートしてレプリカに転送	algolia settings import <index> -F settings.json -f

ルール

タスク	コマンド
すべてのルールを閲覧	algolia rules browse <index>
ルールをインポート	algolia rules import <index> -F rules.ndjson -y
すべてのルールを置き換え	algolia rules import <index> -F rules.ndjson -c -y
ID でルールを削除	algolia rules delete <index> --rule-ids id1,id2 -y

同義語

タスク	コマンド
すべての同義語を閲覧	algolia synonyms browse <index>
同義語をインポート	algolia synonyms import <index> -F synonyms.ndjson
すべての同義語を置き換え	algolia synonyms import <index> -F synonyms.ndjson -r
ID で同義語を削除	algolia synonyms delete <index> --synonym-ids id1,id2 -y
同義語を 1 件保存	algolia synonyms save <index> --id my-syn --synonyms foo,bar

クローラー

タスク	コマンド
クローラーの一覧を表示する	algolia crawler list
アプリごとに一覧を表示する	algolia crawler list --app-id <app-id>
クローラーの詳細を取得する	algolia crawler get <id>
設定のみを取得する	algolia crawler get <id> --config-only
クローラーを作成する	algolia crawler create <name> -F config.json
クローラーを開始／再開する	algolia crawler run <id>
クローラーを一時停止する	algolia crawler pause <id> [<id2> ...]
クローラーを再インデックスする	algolia crawler reindex <id> [<id2> ...]
クローラーのブロックを解除する	algolia crawler unblock <id> -y
指定した URL をクロールする	algolia crawler crawl <id> --urls url1,url2
クローラーに対して URL をテストする	algolia crawler test <id> --url <url>
設定を上書きしてテストする	algolia crawler test <id> --url <url> -F config.json
クロール統計を取得する	algolia crawler stats <id>

ほとんどのクローラーコマンドは --dry-run に対応しており、リクエストを送信せずに内容を確認できます。対象コマンドは create、run、pause、reindex、unblock、test です。

認証： クローラーコマンドを使用するには、環境変数 ALGOLIA_CRAWLER_USER_ID と ALGOLIA_CRAWLER_API_KEY を設定するか、プロファイル設定ファイルに crawler_user_id／crawler_api_key を指定する必要があります。

同義語タイプガイド

検索品質を高めるには、適切な同義語タイプを選ぶことが重要です。

• synonym（通常／双方向）： すべての用語を相互に置き換えられます。両方向で本当に同じ意味を持つ単語に使用します。 例：「sneakers」↔「trainers」— どちらで検索しても、もう一方が見つかるようにします。
• oneWaySynonym： input の用語だけが synonyms を含むように展開され、逆方向には展開されません。短縮語や略語から長い用語や具体的な用語に一致させたい場合に使用しますが、逆方向には一致させません。 例：「TV」→「television」、「flat screen」— 「TV」で検索すると「television」の結果が見つかりますが、「television」で検索しても「TV」の結果は返されません。

目安： 「X で検索したときに Y にも一致させたい」という場合は、片方向（input: X、synonyms: [Y]）です。「X と Y を同等／相互に置き換え可能にしたい」という場合は、双方向です。

説明

タスク	コマンド
ルートコマンドツリーを説明する	algolia describe
コマンドを説明する	algolia describe search
サブコマンドを説明する	algolia describe objects browse

主な規則

1. 必ず非対話モードを使用してください。 破壊的なコマンドでは、確認プロンプトをスキップするために -y（または --confirm）が必要です。これには objects delete、indices delete/clear/copy/move、rules import/delete、synonyms delete、apikeys delete が含まれます。-y を指定しないと、CLI はユーザー入力を待って停止します。注：objects import、objects update、synonyms import には -y フラグがなく、デフォルトで非対話的に実行されます。
2. ndjson 形式。 objects browse、objects import、rules browse/import、synonyms browse/import は、JSON 配列ではなく、改行区切りの JSON（1 行につき JSON オブジェクト 1 つ）を使用します。
3. プロファイルフラグ。 デフォルト以外のプロファイルを対象にするには、-p <profile> を使用します。デフォルトのプロファイルを使用する場合は省略してください。
4. 認証情報の優先順位。 環境変数は他のすべての設定より優先されます。解決順序は、環境変数 > CLI フラグ（--application-id、--api-key）> プロファイル設定ファイル > デフォルトプロファイル です。対応する環境変数：ALGOLIA_APPLICATION_ID、ALGOLIA_API_KEY、ALGOLIA_ADMIN_API_KEY、ALGOLIA_SEARCH_HOSTS、ALGOLIA_CRAWLER_USER_ID、ALGOLIA_CRAWLER_API_KEY。環境変数が設定されている場合、それらの認証情報については --profile／-p は無視されます。
5. 待機フラグ。 後続のコマンドが処理の完了に依存する場合（例：インポートしてから検索する場合）は、-w（または --wait）を使用します。
6. コマンド間のパイプ。 インデックス間でデータをコピーします：algolia objects browse SRC | algolia objects import DST -F -
7. JSON 出力。 機械可読な出力が必要な場合は、--output json（または -o json）を使用します。

よく使うワークフロー

フィールドを絞り込んでインデックス間でレコードを移行する

algolia objects browse SOURCE --attributesToRetrieve objectID,title,price \
  | algolia objects import DEST -F - -w

インデックスの完全バックアップ

algolia objects browse MY_INDEX > my_index_records.ndjson
algolia settings get MY_INDEX > my_index_settings.json
algolia rules browse MY_INDEX > my_index_rules.ndjson
algolia synonyms browse MY_INDEX > my_index_synonyms.ndjson

注：設定には .json（標準 JSON）を使用し、それ以外には .ndjson（改行区切りの JSON）を使用します。

バックアップから復元する

algolia objects import MY_INDEX -F my_index_records.ndjson -w
algolia settings import MY_INDEX -F my_index_settings.json -w
algolia rules import MY_INDEX -F my_index_rules.ndjson -c -y -w
algolia synonyms import MY_INDEX -F my_index_synonyms.ndjson -r -w

直接呼び出す

スキルが自動的に起動しない場合は、ユーザーが直接呼び出せます。

• /algolia-cli — Algolia CLI のタスクで、スキル全体をコンテキストに読み込みます
• /algolia-cli:cli-setup — CLI をインストールし、プロファイルを設定します

依頼が短い場合（例：「自分のデータを Algolia にインポートして」）、スキルが自動的に起動しないことがあるため、この方法が役立ちます。

参考ドキュメント

• はじめに — インストールとプロファイルの設定
• コマンドリファレンス — すべてのコマンドの完全な構文、フラグ、使用例