メインコンテンツへスキップ
expl をインストールし、サインインして、公開されたコンテンツを検索して読みます。次の手順を順に行うと、このページ 1 つで最初の結果まで進めます。

手順

1. インストールする

Exploratory Desktop をお使いの場合、expl は同梱されています。お使いでない場合は、npm でインストールします。Node.js 20 以降が必要です。
最新のバージョンがインストールされます。バージョンを固定するときは、インストールを参照してください。新しいターミナルを開いて、確認します。
1 行目が expl <version> と表示されれば、インストールは完了しています。
そのほかのインストール方法や、2 つ入っているときの確認は、インストールを参照してください。

2. サインインする

ブラウザが開きます。Exploratory にサインインして、アクセスを許可します。
サーバー、ユーザー、サインインの方法を表示します。login のあとに「Logged in to exploratory.io as …」と表示されていれば、サインインできています。

3. 探す

検索語を、コマンドのすぐあとに書きます。このように、フラグの名前を付けずに書く値を位置引数と呼びます。
--scope all は、自分のコンテンツに加えて、ほかの人が公開したコンテンツも検索します。--type data は、結果をデータだけに絞り込みます。結果が空のときは、該当するものがなかったということで、サインインのエラーではありません。ノートを探すときは、--type note を使います。 実行結果
コンテンツの id と URL が並んだ結果が表示されていれば、検索できています。

4. 読む

<id> は、検索結果に表示された id に置き換えます。--json を付けると、サーバーの結果を JSON のまま出力します。実行結果の ID・URL・人名は、説明用に置き換えています。長い出力は省略しているので、次の JSON は抜粋で、完全な JSON ではありません。 実行結果
結果には、本文が含まれます。ノート、ダッシュボード、スライドでは、長さや指定によって、見出しの一覧(metadata.toc)も含まれます。ない場合は、--include-toc を付けて返すか、--query で見出しの id を調べます。

5. 集計する(任意)

データのコンテンツでは、まず列の名前と型を確認します。
<id> は、データの id に置き換えます。実行結果の ID・URL・人名は、説明用に置き換えています。長い出力は省略しています。 実行結果
列の名前がわかったら、集計します。次の例は、region 列の値ごとに sales 列の合計を求め、大きい順に並べます。
<dataset_id> はデータの id、region は実際の列の名前に置き換えます。JSON は、全体を単引用符(‘)で囲みます。実行結果の ID・URL・人名は、説明用に置き換えています。結果は、Sales Orders データで地域ごとの売上(sales)を合計したものです。値は、Sales Orders Dashboard の Sales by Region と一致します。 実行結果
結果には、データのバージョンと更新時刻が含まれます。いつのデータで集計したかも、あわせて確認してください。

うまくいかないとき

  • 検索結果が空です: 該当するものがなかったということで、サインインのエラーではありません。検索語を変えるか、--scope all を付けます。
  • ブラウザを開けません: ブラウザのないスクリプトや 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 を調べます。
詳しくはトラブルシューティングを参照してください。

次に読むもの