このガイドでは、ライブラリ利用者がライブラリを実行するための最小限の手順を説明します。
npm install -D algolia-uploaderローカルで実行する場合は、以下のような .env ファイルを作成します。
ALGOLIA_APP_ID=1234abcd5768
ALGOLIA_ADMIN_API_KEY=hogehigehuge
ALGOLIA_INDEX_NAME=algoliaIndexName必要な環境変数は次のとおりです。
| 環境変数 | 説明 |
|---|---|
ALGOLIA_APP_ID |
Algolia の App ID です。 |
ALGOLIA_ADMIN_API_KEY |
Algolia の API Key です。インデックスを更新できるKeyであればAdmin API Keyでなくてもよいです。 |
ALGOLIA_INDEX_NAME |
Algolia で使用している Index 名です。 |
DATA_DIR |
(非推奨) v0.0.22で廃止されます。代わりに --data-files を使ってください。 |
AlgoliaにアップロードするJSONファイルは、個別のファイルパスを --data-files フラグで指定してください。
- 対応しているのは JSON ファイルのみです。
- 各アイテムには
objectIDフィールドが必要です。
package.jsonで以下のようなscriptを設定してください（複数ファイルはスペース区切りで指定できます）：
{
"scripts": {
"algolia": "algolia-uploader --data-files path/to/a.json path/to/b.json"
}
}--data-files の後に続けて指定した追加のパスは位置引数として扱われます。--data-files を伴わない位置引数のみの指定は引き続きサポートされません。