> ## 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.

# Installation

> Install Octoparse CLI with npm, check Node.js and platform requirements, and verify the local engine, Chrome, and user-browser readiness.

Octoparse CLI is distributed as an npm package and runs on Node.js 20 or newer.

## Requirements

Before installing Octoparse CLI, make sure your environment has:

* Node.js 20 or newer
* npm 8 or newer
* A terminal or command-line shell

Check your Node.js and npm versions:

```bash theme={null}
node -v
npm -v
```

If your Node.js version is lower than 20, upgrade before continuing.

<Card title="Download Node.js" href="https://nodejs.org/">
  Install Node.js 20 or newer for your operating system.
</Card>

### Supported platforms for local extraction

Local extraction uses an independent Chrome runtime. Supported platforms:

* macOS (x64 and arm64)
* Windows (x64)
* Linux (x64)

<Warning>
  Linux arm64 is not supported for local extraction. Chrome for Testing does not provide a Linux arm64 package. If you are running on an ARM server or an Apple Silicon container with a Linux arm64 image, local `run` and `detect` commands will fail. Cloud Extraction (`octoparse cloud start`) works on any platform.
</Warning>

## Install with npm

Install Octoparse CLI globally:

```bash theme={null}
npm install -g @octoparse-ai/octoparse-cli
```

After installation, the `octoparse` command is available globally.

## Verify the installation

### Quick checks

Check the installed version:

```bash theme={null}
octoparse --version
```

Open the help output:

```bash theme={null}
octoparse --help
```

### Understand doctor output

Run diagnostics:

```bash theme={null}
octoparse doctor
```

`octoparse doctor` checks Node.js, the embedded Octoparse engine, runtime extensions, Chrome availability, and browser mode.

A successful result returns `"ok": true`:

```json theme={null}
{
  "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` — the Octoparse desktop app is not required for CLI execution.
* `browser-mode: independent Chrome only` — local extraction uses an independent Chrome runtime, not the desktop client's browser.

If `chrome` shows `ok: false`, see [Troubleshooting](#troubleshooting) below.

Use a custom Chrome path if needed:

```bash theme={null}
octoparse doctor --chrome-path /path/to/chrome
```

### Check user-browser readiness

```bash theme={null}
octoparse browser status
```

Use JSON output for structured environment and user-browser checks:

```bash theme={null}
octoparse doctor --json
octoparse browser status --json
```

## Manage your installation

### Update Octoparse CLI

Run the npm install command again to update:

```bash theme={null}
npm install -g @octoparse-ai/octoparse-cli
octoparse --version
```

### Uninstall Octoparse CLI

```bash theme={null}
npm uninstall -g @octoparse-ai/octoparse-cli
```

If the shell returns `octoparse: command not found`, the command has been removed.

## Troubleshooting

| Issue | What to check |
| - | - |
| `octoparse: command not found` | Confirm the npm global binary directory is in your `PATH` |
| Permission error during installation | Check npm global package permissions or use a Node.js version manager. [See npm guide →](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally) |
| Node.js version is too old | Upgrade to Node.js 20 or newer |
| npm install times out | Check your npm registry, proxy, VPN, or firewall settings |
| Chrome fails to download | Check your network access to the Chrome for Testing CDN. Try `--chrome-path` to use a locally installed Chrome |
| Linux arm64 unsupported | Use a Linux x64 environment, or switch to Cloud Extraction with `octoparse cloud start` |
| `doctor` shows a failed check | Fix the flagged dependency (Node.js, Chrome, engine files), then run `octoparse doctor` again. Share the `ok: false` output with Octoparse support if the issue persists |

## What's next

<CardGroup cols={3}>
  <Card title="Get an API key and log in" href="/docs/en/cli/quick-start/get-api-key-and-log-in">
    Create an Octoparse API key and authenticate the CLI.
  </Card>

  <Card title="Run your first task" href="/docs/en/cli/quick-start/run-your-first-task">
    List tasks, inspect a task, run it locally, and export data.
  </Card>

  <Card title="Browse all commands" href="../reference/command-cheatsheet">
    Review common CLI commands for tasks, local runs, cloud runs, and exports.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.