メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://www.octoparse.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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をアップグレードしてください。npmが見つからない、または古い場合は、Node.jsを再インストールまたはアップグレードしてください。npmは通常Node.jsに同梱されています。

Node.jsをダウンロード

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

​
npmでインストールする

Octoparse CLIをグローバルにインストールします。 
npm install -g @octoparse-cli/octoparse-cli
インストール後、CLIコマンドは次の名前で利用できます。 
octoparse

​
インストールを確認する

Octoparse CLIをインストールしたら、コマンドが利用可能で、ローカルランタイムが準備できていることを確認します。

​
クイックチェック

インストールされたバージョンを確認します。 
octoparse --version
ヘルプ出力を表示します。 
octoparse --help
octoparse --help は、利用可能なコマンド、オプション、認証ルール、終了コードを表示します。

​
doctor出力を確認する

診断を実行します。 
octoparse doctor
octoparse doctor は、ローカル環境でOctoparse CLIを実行できる状態かどうかを確認します。Node.js、組み込みのOctoparseエンジン、ランタイム拡張、Chromeの可用性、ブラウザモードを検証します。 成功した場合、結果には "ok": true が返されます。 
{
  "ok": true,
  "checks": [
    {
      "name": "node",
      "ok": true,
      "message": "v24.14.0"
    },
    {
      "name": "electron-client",
      "ok": true,
      "message": "not required"
    },
    {
      "name": "browser-mode",
      "ok": true,
      "message": "independent Chrome only"
    }
  ]
}
この例では：
  • node はNode.jsが利用可能であることを示します。
  • electron-client: not required は、CLIの実行にOctoparseデスクトップアプリが不要であることを意味します。
  • browser-mode: independent Chrome only は、ローカル抽出がデスクトップクライアントのブラウザではなく、独立したChromeランタイムを使用することを意味します。

​
ブラウザ診断を確認する

ブラウザ環境を個別に確認します。 
octoparse browser doctor

​
インストールを管理する

Octoparse CLIの更新または削除には、同じnpmパッケージ名を使用します。

​
Octoparse CLIを更新する

最新の公開バージョンに更新するには、npmのグローバルインストールコマンドを再度実行します。 
npm install -g @octoparse-cli/octoparse-cli
その後、インストールされたバージョンを確認します。 
octoparse --version

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

グローバルインストールを削除します。 
npm uninstall -g @octoparse-cli/octoparse-cli
その後、コマンドが削除されたことを確認します。 
octoparse --version
シェルが octoparse: command not found を返す場合、グローバルコマンドは削除されています。

​
トラブルシューティング

問題確認すること
octoparse: command not foundnpmのグローバルバイナリディレクトリがシェルの PATH に含まれているか確認します
インストール時の権限エラーnpmのグローバルパッケージ権限を確認するか、Node.jsのバージョンマネージャーを使用します。npmガイドを見る →
Node.jsのバージョンが古いNode.js 20以降にアップグレードします
npm install がタイムアウトするnpm registry、プロキシ、VPN、ファイアウォール設定を確認します
診断が失敗するoctoparse doctor 出力の ok: false の項目を確認し、Node.js、Chrome、エンジンファイル、ブラウザモードなど関連する依存関係を修正します
npmの権限問題については、EACCES権限エラーを解決するnpm公式ガイドを参照してください。
Octoparse固有の診断については、octoparse doctor を実行し、失敗したチェック項目をOctoparseサポートに共有してください。

​
次のステップ

インストールが成功したら、次の手順に進んでください。

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

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

最初のタスクを実行する

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

すべてのコマンドを見る

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