openclaw.ai.
| Script | Platform | What it does |
|---|---|---|
install.sh | macOS / Linux / WSL | Installs Node if needed, installs OpenClaw via npm (default) or git, can run onboarding. |
install-cli.sh | macOS / Linux / WSL | Installs Node + OpenClaw into a local prefix (~/.openclaw) via npm or git. No root required. |
install.ps1 | Windows (PowerShell) | Installs Node if needed, installs OpenClaw via npm (default) or git, can run onboarding. |
Quick commands
- install.sh
- install-cli.sh
- install.ps1
If install succeeds but
openclaw is not found in a new terminal, see Node.js troubleshooting.install.sh
Flow (install.sh)
Ensure Node.js 24 by default
Checks Node version and installs Node 24 if needed (Homebrew on macOS, NodeSource setup scripts on Linux apt/dnf/yum). On macOS, Homebrew is installed only when the installer needs it for Node or Git. Node 22.19+ and 23.11+ remain supported for compatibility.
On Alpine/musl Linux, the installer uses apk packages instead of NodeSource; the configured Alpine repositories must provide a supported Node version (Alpine 3.21 or newer at the time of writing).
Ensure Git
Installs Git if missing using the detected package manager, including Homebrew on macOS and apk on Alpine.
Install OpenClaw
npmmethod (default): global npm installgitmethod: clone/update repo, install deps with pnpm, build, then install wrapper at~/.local/bin/openclaw
Post-install tasks
- Refreshes a loaded gateway service best-effort (
openclaw gateway install --force, then restart) - Runs
openclaw doctor --non-interactiveon upgrades and git installs (best effort) - Attempts onboarding when appropriate (TTY available, onboarding not disabled, and bootstrap/config checks pass)
- Runs a post-install smoke verify when
--verifyis set
Source checkout detection
If run inside an OpenClaw checkout (package.json + pnpm-workspace.yaml), the script offers:
- use checkout (
git), or - use global install (
npm)
npm and warns.
The script exits with code 2 for invalid method selection or invalid --install-method values.
Examples (install.sh)
- Default
- Skip onboarding
- Git install
- GitHub main checkout
- Dry run
- Verify after install
Flags reference
Flags reference
| Flag | Description |
|---|---|
--install-method | --method npm|git | Choose install method (default: npm) |
--npm | Shortcut for npm method |
--git | --github | Shortcut for git method |
--version <version|dist-tag|spec> | npm version, dist-tag, or package spec (default: latest) |
--beta | Use beta dist-tag if available, else fall back to latest |
--git-dir | --dir <path> | Checkout directory (default: ~/openclaw) |
--no-git-update | Skip git pull for existing checkout |
--no-prompt | Disable prompts |
--no-onboard | Skip onboarding |
--onboard | Enable onboarding |
--verify | Run a post-install smoke verify (--version, gateway health if loaded) |
--dry-run | Print actions without applying changes |
--verbose | Enable debug output (set -x, npm notice-level logs) |
--help | -h | Show usage |
Environment variables reference
Environment variables reference
| Variable | Description |
|---|---|
OPENCLAW_INSTALL_METHOD=git|npm | Install method |
OPENCLAW_VERSION=latest|next|<semver>|<spec> | npm version, dist-tag, or package spec |
OPENCLAW_BETA=0|1 | Use beta if available |
OPENCLAW_HOME=<path> | Base directory for OpenClaw state and default git/onboarding paths |
OPENCLAW_GIT_DIR=<path> | Checkout directory |
OPENCLAW_GIT_UPDATE=0|1 | Toggle git updates |
OPENCLAW_NO_PROMPT=1 | Disable prompts |
OPENCLAW_VERIFY_INSTALL=1 | Run the post-install smoke verify |
OPENCLAW_NO_ONBOARD=1 | Skip onboarding |
OPENCLAW_DRY_RUN=1 | Dry run mode |
OPENCLAW_VERBOSE=1 | Debug mode |
OPENCLAW_NPM_LOGLEVEL=error|warn|notice | npm log level (default: error, hides npm deprecation noise) |
install-cli.sh
Designed for environments where you want everything under a local prefix
(default
~/.openclaw) and no system Node dependency. Supports npm installs
by default, plus git-checkout installs under the same prefix flow.Flow (install-cli.sh)
Install local Node runtime
Downloads a pinned supported Node LTS tarball (the version is embedded in the script and updated independently, default
22.22.0) to <prefix>/tools/node-v<version> and verifies SHA-256.
On Alpine/musl Linux, where Node does not publish compatible tarballs for the pinned runtime, installs nodejs and npm with apk and links that runtime into the prefix wrapper path. The Alpine repositories must provide a supported Node version (22.19+, 23.11+, or 24+); use Alpine 3.21 or newer if older repositories only provide Node 20 or 21.Install OpenClaw under prefix
npmmethod (default): installs under the prefix with npm, then writes wrapper to<prefix>/bin/openclawgitmethod: clones/updates a checkout (default~/openclaw) and still writes the wrapper to<prefix>/bin/openclaw
Examples (install-cli.sh)
- Default
- Custom prefix + version
- Git install
- Automation JSON output
- Run onboarding
Flags reference
Flags reference
| Flag | Description |
|---|---|
--prefix <path> | Install prefix (default: ~/.openclaw) |
--install-method | --method npm|git | Choose install method (default: npm) |
--npm | Shortcut for npm method |
--git | --github | Shortcut for git method |
--git-dir | --dir <path> | Git checkout directory (default: ~/openclaw) |
--version <ver> | OpenClaw version or dist-tag (default: latest) |
--node-version <ver> | Node version (default: 22.22.0) |
--json | Emit NDJSON events |
--onboard | Run openclaw onboard after install |
--no-onboard | Skip onboarding (default) |
--set-npm-prefix | On Linux, force npm prefix to ~/.npm-global if current prefix is not writable |
--help | -h | Show usage |
Environment variables reference
Environment variables reference
| Variable | Description |
|---|---|
OPENCLAW_PREFIX=<path> | Install prefix |
OPENCLAW_INSTALL_METHOD=git|npm | Install method |
OPENCLAW_VERSION=<ver> | OpenClaw version or dist-tag |
OPENCLAW_NODE_VERSION=<ver> | Node version |
OPENCLAW_HOME=<path> | Base directory for OpenClaw state and default git/onboarding paths |
OPENCLAW_GIT_DIR=<path> | Git checkout directory for git installs |
OPENCLAW_GIT_UPDATE=0|1 | Toggle git updates for existing checkouts |
OPENCLAW_NO_ONBOARD=1 | Skip onboarding |
OPENCLAW_NPM_LOGLEVEL=error|warn|notice | npm log level (default: error) |
openclaw@main and other GitHub source specs are not valid --version targets for npm installs. Use --install-method git --version main instead.install.ps1
Flow (install.ps1)
Ensure Node.js 24 by default
If missing, attempts install via winget, then Chocolatey, then Scoop. If no package manager is available, the script downloads the official Node.js 24 Windows zip into
%LOCALAPPDATA%\OpenClaw\deps\portable-node and adds it to the current process and user PATH. Node 22.19+ and 23.11+ remain supported for compatibility.Install OpenClaw
npmmethod (default): global npm install using the selected-Tag, launched from a writable installer temp directory so shells opened in protected folders such asC:\still workgitmethod: clone/update repo, install/build with pnpm, and install wrapper at%USERPROFILE%\.local\bin\openclaw.cmd. If Git is missing, the script bootstraps user-local MinGit under%LOCALAPPDATA%\OpenClaw\deps\portable-gitand adds it to the current process and user PATH.
Post-install tasks
- Adds needed bin directory to user PATH when possible
- Refreshes a loaded gateway service best-effort (
openclaw gateway install --force, then restart) - Runs
openclaw doctor --non-interactiveon upgrades and git installs (best effort)
Examples (install.ps1)
- Default
- Git install
- GitHub main checkout
- Custom git directory
- Dry run
Flags reference
Flags reference
| Flag | Description |
|---|---|
-InstallMethod npm|git | Install method (default: npm) |
-Tag <tag|version|spec> | npm dist-tag, version, or package spec (default: latest) |
-GitDir <path> | Checkout directory (default: %USERPROFILE%\openclaw) |
-NoOnboard | Skip onboarding |
-NoGitUpdate | Skip git pull |
-DryRun | Print actions only |
Environment variables reference
Environment variables reference
| Variable | Description |
|---|---|
OPENCLAW_INSTALL_METHOD=git|npm | Install method |
OPENCLAW_GIT_DIR=<path> | Checkout directory |
OPENCLAW_NO_ONBOARD=1 | Skip onboarding |
OPENCLAW_GIT_UPDATE=0 | Disable git pull |
OPENCLAW_DRY_RUN=1 | Dry run mode |
If
-InstallMethod git is used and Git is missing, the script tries a user-local MinGit bootstrap before printing the Git for Windows link.CI and automation
Use non-interactive flags/env vars for predictable runs.- install.sh (non-interactive npm)
- install.sh (non-interactive git)
- install-cli.sh (JSON)
- install.ps1 (skip onboarding)
Troubleshooting
Why is Git required?
Why is Git required?
Git is required for the
git install method. For npm installs, Git is still checked/installed to avoid spawn git ENOENT failures when dependencies use git URLs.Why does npm hit EACCES on Linux?
Why does npm hit EACCES on Linux?
Some Linux setups point npm’s global prefix to root-owned paths.
install.sh can switch the prefix to ~/.npm-global and append PATH exports to shell rc files (when those files exist).Windows: "npm error spawn git / ENOENT"
Windows: "npm error spawn git / ENOENT"
Rerun the installer so it can bootstrap user-local MinGit, or install Git for Windows and reopen PowerShell.
Windows: "openclaw is not recognized"
Windows: "openclaw is not recognized"
Run
npm config get prefix and add that directory to your user PATH (no \bin suffix needed on Windows), then reopen PowerShell.Windows: how to get verbose installer output
Windows: how to get verbose installer output
install.ps1 does not expose a -Verbose switch.
Use PowerShell tracing for script-level diagnostics:openclaw not found after install
openclaw not found after install
Usually a PATH issue. See Node.js troubleshooting.