CLI を使い始める

​
research boxil

BOXIL のカテゴリ、製品、レビュー、記事を調査します。掲載位置、スポンサー表示、資料請求ランキングを区別して比較します。

​
使い方

terminal
orc research boxil categories list --q 電子契約 --workspace YOUR_WORKSPACE_ID --json

カテゴリを検索する

​
サブコマンド

​
article get

articleを取得します。

terminal
orc research boxil article get <id> [options]

​
固有のオプション

​
--include-raw

enum: true|false

型: string。任意。

terminal
orc research boxil article get <id> --include-raw <value>
​
--full

enum: true|false

型: string。任意。

terminal
orc research boxil article get <id> --full <value>

​
categories list

カテゴリを一覧取得します。

terminal
orc research boxil categories list [options]

​
固有のオプション

​
--include-raw

enum: true|false

型: string。任意。

terminal
orc research boxil categories list --include-raw <value>
​
--full

enum: true|false

型: string。任意。

terminal
orc research boxil categories list --full <value>
​
--q

max 200 chars

型: string。任意。

terminal
orc research boxil categories list --q <value>

​
products list

製品を一覧取得します。

terminal
orc research boxil products list <slug> [options]

​
固有のオプション

​
--include-raw

enum: true|false

型: string。任意。

terminal
orc research boxil products list <slug> --include-raw <value>
​
--full

enum: true|false

型: string。任意。

terminal
orc research boxil products list <slug> --full <value>
​
--all-pages

enum: true|false

型: string。任意。

terminal
orc research boxil products list <slug> --all-pages <value>
​
--max-pages

value

型: number。任意。

terminal
orc research boxil products list <slug> --max-pages <value>
​
--page

value

型: number。任意。

terminal
orc research boxil products list <slug> --page <value>

​
ranking get

資料請求ランキングを取得します。

terminal
orc research boxil ranking get <slug> [options]

​
固有のオプション

​
--include-raw

enum: true|false

型: string。任意。

terminal
orc research boxil ranking get <slug> --include-raw <value>
​
--full

enum: true|false

型: string。任意。

terminal
orc research boxil ranking get <slug> --full <value>

​
discovery get

公開ディスカバリー情報を取得します。

terminal
orc research boxil discovery get [options]

​
固有のオプション

​
--include-raw

enum: true|false

型: string。任意。

terminal
orc research boxil discovery get --include-raw <value>
​
--full

enum: true|false

型: string。任意。

terminal
orc research boxil discovery get --full <value>
​
--kind

enum: robots|llms|sitemap|mag-sitemap

型: string。任意。

terminal
orc research boxil discovery get --kind <value>

​
product get

productを取得します。

terminal
orc research boxil product get <id> [options]

​
固有のオプション

​
--include-raw

enum: true|false

型: string。任意。

terminal
orc research boxil product get <id> --include-raw <value>
​
--full

enum: true|false

型: string。任意。

terminal
orc research boxil product get <id> --full <value>

​
reviews list

レビューを一覧取得します。

terminal
orc research boxil reviews list <id> [options]

​
固有のオプション

​
--include-raw

enum: true|false

型: string。任意。

terminal
orc research boxil reviews list <id> --include-raw <value>
​
--full

enum: true|false

型: string。任意。

terminal
orc research boxil reviews list <id> --full <value>
​
--all-pages

enum: true|false

型: string。任意。

terminal
orc research boxil reviews list <id> --all-pages <value>
​
--max-pages

value

型: number。任意。

terminal
orc research boxil reviews list <id> --max-pages <value>
​
--page

value

型: number。任意。

terminal
orc research boxil reviews list <id> --page <value>

​
search

製品を検索します。

terminal
orc research boxil search [options]

​
固有のオプション

​
--include-raw

enum: true|false

型: string。任意。

terminal
orc research boxil search --include-raw <value>
​
--full

enum: true|false

型: string。任意。

terminal
orc research boxil search --full <value>
​
--all-pages

enum: true|false

型: string。任意。

terminal
orc research boxil search --all-pages <value>
​
--max-pages

value

型: number。任意。

terminal
orc research boxil search --max-pages <value>
​
--page

value

型: number。任意。

terminal
orc research boxil search --page <value>
​
--q

max 70 chars

型: string。必須。

terminal
orc research boxil search --q <value>

​
使用例

​
カテゴリの製品を取得する

terminal
orc research boxil products list electronic_contract --page 1 --workspace YOUR_WORKSPACE_ID --json

カテゴリの製品を取得する

​
製品の詳細を取得する

terminal
orc research boxil product get 611 --workspace YOUR_WORKSPACE_ID --json

製品の詳細を取得する

​
全ページと元データを保存する

terminal
orc research boxil products list electronic_contract --all-pages true --include-raw true --full true --workspace YOUR_WORKSPACE_ID --json --output result.json

全ページと元データを保存する

​
取得結果と保存

製品詳細には会社情報と複数カテゴリを含めます。製品一覧の position は掲載位置、sponsored はPR表示です。重複掲載は独立した製品数とは限りません。ランキングは資料請求に基づき、満足度順位ではありません。不明な料金・評価・会社情報は推測しません。

ページ送りのある一覧は --all-pages true で続けて取得できます。--max-pages は1回の取得上限（既定100ページ）です。collection の fetched_count、pages_fetched、complete、stop_reason、next_url、failure で取得件数・終端・途中失敗を確認してください。上限や失敗で停止した結果を全件取得済みと扱わないでください。

--include-raw true は取得したHTML／JSONを raw_sources に含めます。抽出項目と原文をまとめて保存するには --json --output result.json を指定します。--raw はCLIの表示用オプションで、原文取得とは異なります。

--full true は本文の切り詰めとcompact表示を避けます。省略は omissions と各本文の truncated で確認します。収集オプション指定時の既定表示はJSONです。表・CSVやフィールド選択は情報を絞るため、再抽出用の保存にはJSONを使用してください。

​
必要な権限

orc auth login でベータ承認済みアカウントにログインするか、read スコープの API キーを使用します。アクセスできる Workspace を --workspace で指定します。research 専用の Workspace 許可リストは不要です。

​
グローバルオプション

orc research boxil では、次のグローバルオプションを使用できます。

各オプションの詳細と使用例は、グローバルオプションを参照してください。