手順
1. インストールする
Exploratory Desktop をお使いの場合、expl は同梱されています。お使いでない場合は、npm でインストールします。Node.js 20 以降が必要です。1 行目が expl <version> と表示されれば、インストールは完了しています。そのほかのインストール方法や、2 つ入っているときの確認は、インストールを参照してください。
2. サインインする
3. 探す
検索語を、コマンドのすぐあとに書きます。このように、フラグの名前を付けずに書く値を位置引数と呼びます。--scope all は、自分のコンテンツに加えて、ほかの人が公開したコンテンツも検索します。--type data は、結果をデータだけに絞り込みます。結果が空のときは、該当するものがなかったということで、サインインのエラーではありません。ノートを探すときは、--type note を使います。
実行結果
コンテンツの id と URL が並んだ結果が表示されていれば、検索できています。
4. 読む
--json を付けると、サーバーの結果を JSON のまま出力します。実行結果の ID・URL・人名は、説明用に置き換えています。長い出力は省略しているので、次の JSON は抜粋で、完全な JSON ではありません。
実行結果
--include-toc を付けて返すか、--query で見出しの id を調べます。
5. 集計する(任意)
データのコンテンツでは、まず列の名前と型を確認します。うまくいかないとき
- 検索結果が空です: 該当するものがなかったということで、サインインのエラーではありません。検索語を変えるか、
--scopeall を付けます。 - ブラウザを開けません: ブラウザのないスクリプトや CI では、代わりに API キーでサインインします(
expl server login --with-token。API キーを参照)。ブラウザを開けないマシンでは、サインインを参照してください。 Run "expl server login".と表示されます: サインインしていないか、保存したログイン情報が拒否されています。expl server login を実行します。- expl: command not found と表示されます: 新しいターミナルを開いて、もう一度試します。
- どの id を使えばよいか分かりません: 検索結果に表示された id を使います。
- ノートで見出しの一覧(metadata.toc)が出ません:
--include-tocを付けるか、--queryで見出しの id を調べます。
次に読むもの
- ノートを読む - 長いノートの読み方と、チャートの数値の取り方です。
- データを集計する - JSON で渡す引数の書き方です。
- 自動処理 - API キーを作成し、CI で実行します。
- 使い方 - やりたいことからコマンドを探します。
- トラブルシューティング - 症状から対処を探します。
