インストール - Octoparse Docs

Octoparse CLIはnpmパッケージとして配布され、Node.js 20以降で動作します。

要件

Octoparse CLIをインストールする前に、環境に次のものがあることを確認してください。

Node.js 20以降
npm 8以降
ターミナルまたはコマンドラインシェル

Node.jsとnpmのバージョンを確認します。

node -v
npm -v

Node.jsのバージョンが20未満の場合は、続行する前にアップグレードしてください。

Node.jsをダウンロード

お使いのOSにNode.js 20以降をインストールします。

ローカル抽出のサポートプラットフォーム

ローカル抽出は独立したChromeランタイムを使用します。サポートされているプラットフォーム：

macOS（x64およびarm64）
Windows（x64）
Linux（x64）

Linux arm64はローカル抽出をサポートしていません。Chrome for TestingにはLinux arm64パッケージが存在しないためです。ARM サーバーまたはApple SiliconコンテナでLinux arm64イメージを使用している場合、ローカルの run および detect コマンドは失敗します。クラウド抽出（octoparse cloud start）はすべてのプラットフォームで動作します。

npmでインストールする

Octoparse CLIをグローバルにインストールします。

npm install -g @octoparse-cli/octoparse-cli

インストール後、octoparse コマンドがグローバルに使用できるようになります。

インストールを確認する

クイックチェック

インストールされたバージョンを確認します。

octoparse --version

ヘルプ出力を表示します。

octoparse --help

doctor出力を確認する

診断を実行します。

octoparse doctor

octoparse doctor は、Node.js、組み込みのOctoparseエンジン、ランタイム拡張、Chromeの可用性、ブラウザモードを確認します。成功した場合は "ok": true が返されます。

{
  "ok": true,
  "checks": [
    { "name": "node", "ok": true, "message": "v24.0.0" },
    { "name": "engine", "ok": true, "message": "..." },
    { "name": "electron-client", "ok": true, "message": "not required" },
    { "name": "browser-mode", "ok": true, "message": "independent Chrome only" }
  ]
}

electron-client: not required — CLIの実行にOctoparseデスクトップアプリは不要です。
browser-mode: independent Chrome only — ローカル抽出はデスクトップクライアントのブラウザではなく、独立したChromeランタイムを使用します。

chrome が ok: false の場合は、下記のトラブルシューティングを参照してください。カスタムChromeパスを指定する場合：

octoparse doctor --chrome-path /path/to/chrome

ブラウザ診断を確認する

octoparse browser doctor

構造化された診断情報を取得するには：

octoparse doctor --json
octoparse browser doctor --json

インストールを管理する

Octoparse CLIを更新する

npm install -g @octoparse-cli/octoparse-cli
octoparse --version

Octoparse CLIをアンインストールする

npm uninstall -g @octoparse-cli/octoparse-cli

シェルが octoparse: command not found を返す場合、コマンドは削除されています。

トラブルシューティング

問題	確認すること
`octoparse: command not found`	npmのグローバルバイナリディレクトリがシェルの `PATH` に含まれているか確認します
インストール時の権限エラー	npmのグローバルパッケージ権限を確認するか、Node.jsのバージョンマネージャーを使用します。npmガイドを見る →
Node.jsのバージョンが古い	Node.js 20以降にアップグレードします
npm install がタイムアウトする	npm registry、プロキシ、VPN、ファイアウォール設定を確認します
Chromeのダウンロードが失敗する	ネットワークアクセスを確認し、`--chrome-path` でローカルにインストール済みのChromeを指定します
Linux arm64でサポートされない	Linux x64環境に切り替えるか、`octoparse cloud start` でクラウド抽出を使用します
`doctor` でチェックが失敗する	失敗した依存関係（Node.js、Chrome、エンジンファイル）を修正し、`octoparse doctor` を再実行します。問題が続く場合は、`ok: false` の出力をOctoparseサポートと共有してください

次のステップ

APIキーを取得してログインする

Octoparse APIキーを作成し、CLIを認証します。

最初のタスクを実行する

タスクを一覧表示し、確認し、ローカルで実行し、データをエクスポートします。

すべてのコマンドを見る

タスク、ローカル実行、クラウド実行、エクスポート関連のCLIコマンドを確認します。

APIキーを取得してログイン