mirror of
https://github.com/moltbot/moltbot.git
synced 2026-05-01 18:48:16 +00:00
docs: rewrite install index for readability — flat structure, clearer hierarchy, better hosting cards
This commit is contained in:
Vincent Koc
@@ -867,7 +867,7 @@
|
|||||||
"pages": ["install/index", "install/installer", "install/node"]
|
"pages": ["install/index", "install/installer", "install/node"]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Other install methods",
|
"group": "Containers and package managers",
|
||||||
"pages": [
|
"pages": [
|
||||||
"install/docker",
|
"install/docker",
|
||||||
"install/podman",
|
"install/podman",
|
||||||
|
|||||||
@@ -9,158 +9,113 @@ title: "Install"
|
|||||||
|
|
||||||
# Install
|
# Install
|
||||||
|
|
||||||
Already followed [Getting Started](/start/getting-started)? You're all set — this page is for alternative install methods, platform-specific instructions, and maintenance.
|
## Recommended: installer script
|
||||||
|
|
||||||
|
The fastest way to install. It detects your OS, installs Node if needed, installs OpenClaw, and launches onboarding.
|
||||||
|
|
||||||
|
<Tabs>
|
||||||
|
<Tab title="macOS / Linux / WSL2">
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://openclaw.ai/install.sh | bash
|
||||||
|
```
|
||||||
|
</Tab>
|
||||||
|
<Tab title="Windows (PowerShell)">
|
||||||
|
```powershell
|
||||||
|
iwr -useb https://openclaw.ai/install.ps1 | iex
|
||||||
|
```
|
||||||
|
</Tab>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
|
To install without running onboarding:
|
||||||
|
|
||||||
|
<Tabs>
|
||||||
|
<Tab title="macOS / Linux / WSL2">
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://openclaw.ai/install.sh | bash -s -- --no-onboard
|
||||||
|
```
|
||||||
|
</Tab>
|
||||||
|
<Tab title="Windows (PowerShell)">
|
||||||
|
```powershell
|
||||||
|
& ([scriptblock]::Create((iwr -useb https://openclaw.ai/install.ps1))) -NoOnboard
|
||||||
|
```
|
||||||
|
</Tab>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
|
For all flags and CI/automation options, see [Installer internals](/install/installer).
|
||||||
|
|
||||||
## System requirements
|
## System requirements
|
||||||
|
|
||||||
- **[Node 24 (recommended)](/install/node)** (Node 22 LTS, currently `22.16+`, is still supported for compatibility; the [installer script](#install-methods) will install Node 24 if missing)
|
- **Node 24** (recommended) or Node 22.16+ — the installer script handles this automatically
|
||||||
- macOS, Linux, or Windows
|
- **macOS, Linux, or Windows** — both native Windows and WSL2 are supported; WSL2 is more stable. See [Windows](/platforms/windows).
|
||||||
- `pnpm` only if you build from source
|
- `pnpm` is only needed if you build from source
|
||||||
|
|
||||||
<Note>
|
## Alternative install methods
|
||||||
On Windows, we strongly recommend running OpenClaw under [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).
|
|
||||||
</Note>
|
|
||||||
|
|
||||||
## Install methods
|
### npm or pnpm
|
||||||
|
|
||||||
<Tip>
|
If you already manage Node yourself:
|
||||||
The **installer script** is the recommended way to install OpenClaw. It handles Node detection, installation, and onboarding in one step.
|
|
||||||
</Tip>
|
|
||||||
|
|
||||||
<Warning>
|
|
||||||
For VPS/cloud hosts, avoid third-party "1-click" marketplace images when possible. Prefer a clean base OS image (for example Ubuntu LTS), then install OpenClaw yourself with the installer script.
|
|
||||||
</Warning>
|
|
||||||
|
|
||||||
<AccordionGroup>
|
|
||||||
<Accordion title="Installer script" icon="rocket" defaultOpen>
|
|
||||||
Downloads the CLI, installs it globally via npm, and launches onboarding.
|
|
||||||
|
|
||||||
<Tabs>
|
|
||||||
<Tab title="macOS / Linux / WSL2">
|
|
||||||
```bash
|
|
||||||
curl -fsSL https://openclaw.ai/install.sh | bash
|
|
||||||
```
|
|
||||||
</Tab>
|
|
||||||
<Tab title="Windows (PowerShell)">
|
|
||||||
```powershell
|
|
||||||
iwr -useb https://openclaw.ai/install.ps1 | iex
|
|
||||||
```
|
|
||||||
</Tab>
|
|
||||||
</Tabs>
|
|
||||||
|
|
||||||
That's it — the script handles Node detection, installation, and onboarding.
|
|
||||||
|
|
||||||
To skip onboarding and just install the binary:
|
|
||||||
|
|
||||||
<Tabs>
|
|
||||||
<Tab title="macOS / Linux / WSL2">
|
|
||||||
```bash
|
|
||||||
curl -fsSL https://openclaw.ai/install.sh | bash -s -- --no-onboard
|
|
||||||
```
|
|
||||||
</Tab>
|
|
||||||
<Tab title="Windows (PowerShell)">
|
|
||||||
```powershell
|
|
||||||
& ([scriptblock]::Create((iwr -useb https://openclaw.ai/install.ps1))) -NoOnboard
|
|
||||||
```
|
|
||||||
</Tab>
|
|
||||||
</Tabs>
|
|
||||||
|
|
||||||
For all flags, env vars, and CI/automation options, see [Installer internals](/install/installer).
|
|
||||||
|
|
||||||
</Accordion>
|
|
||||||
|
|
||||||
<Accordion title="npm / pnpm" icon="package">
|
|
||||||
If you already manage Node yourself, we recommend Node 24. OpenClaw still supports Node 22 LTS, currently `22.16+`, for compatibility:
|
|
||||||
|
|
||||||
<Tabs>
|
|
||||||
<Tab title="npm">
|
|
||||||
```bash
|
|
||||||
npm install -g openclaw@latest
|
|
||||||
openclaw onboard --install-daemon
|
|
||||||
```
|
|
||||||
|
|
||||||
<Accordion title="sharp build errors?">
|
|
||||||
If you have libvips installed globally (common on macOS via Homebrew) and `sharp` fails, force prebuilt binaries:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
SHARP_IGNORE_GLOBAL_LIBVIPS=1 npm install -g openclaw@latest
|
|
||||||
```
|
|
||||||
|
|
||||||
If you see `sharp: Please add node-gyp to your dependencies`, either install build tooling (macOS: Xcode CLT + `npm install -g node-gyp`) or use the env var above.
|
|
||||||
</Accordion>
|
|
||||||
</Tab>
|
|
||||||
<Tab title="pnpm">
|
|
||||||
```bash
|
|
||||||
pnpm add -g openclaw@latest
|
|
||||||
pnpm approve-builds -g # approve openclaw, node-llama-cpp, sharp, etc.
|
|
||||||
openclaw onboard --install-daemon
|
|
||||||
```
|
|
||||||
|
|
||||||
<Note>
|
|
||||||
pnpm requires explicit approval for packages with build scripts. After the first install shows the "Ignored build scripts" warning, run `pnpm approve-builds -g` and select the listed packages.
|
|
||||||
</Note>
|
|
||||||
</Tab>
|
|
||||||
</Tabs>
|
|
||||||
|
|
||||||
Want the current GitHub `main` head with a package-manager install?
|
|
||||||
|
|
||||||
|
<Tabs>
|
||||||
|
<Tab title="npm">
|
||||||
```bash
|
```bash
|
||||||
npm install -g github:openclaw/openclaw#main
|
npm install -g openclaw@latest
|
||||||
|
openclaw onboard --install-daemon
|
||||||
|
```
|
||||||
|
</Tab>
|
||||||
|
<Tab title="pnpm">
|
||||||
|
```bash
|
||||||
|
pnpm add -g openclaw@latest
|
||||||
|
pnpm approve-builds -g
|
||||||
|
openclaw onboard --install-daemon
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash
|
<Note>
|
||||||
pnpm add -g github:openclaw/openclaw#main
|
pnpm requires explicit approval for packages with build scripts. Run `pnpm approve-builds -g` after the first install.
|
||||||
```
|
</Note>
|
||||||
|
|
||||||
</Accordion>
|
</Tab>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
<Accordion title="From source" icon="github">
|
<Accordion title="Troubleshooting: sharp build errors (npm)">
|
||||||
For contributors or anyone who wants to run from a local checkout.
|
If `sharp` fails due to a globally installed libvips:
|
||||||
|
|
||||||
<Steps>
|
```bash
|
||||||
<Step title="Clone and build">
|
SHARP_IGNORE_GLOBAL_LIBVIPS=1 npm install -g openclaw@latest
|
||||||
Clone the [OpenClaw repo](https://github.com/openclaw/openclaw) and build:
|
```
|
||||||
|
|
||||||
```bash
|
</Accordion>
|
||||||
git clone https://github.com/openclaw/openclaw.git
|
|
||||||
cd openclaw
|
|
||||||
pnpm install
|
|
||||||
pnpm ui:build
|
|
||||||
pnpm build
|
|
||||||
```
|
|
||||||
</Step>
|
|
||||||
<Step title="Link the CLI">
|
|
||||||
Make the `openclaw` command available globally:
|
|
||||||
|
|
||||||
```bash
|
### From source
|
||||||
pnpm link --global
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively, skip the link and run commands via `pnpm openclaw ...` from inside the repo.
|
For contributors or anyone who wants to run from a local checkout:
|
||||||
</Step>
|
|
||||||
<Step title="Run onboarding">
|
|
||||||
```bash
|
|
||||||
openclaw onboard --install-daemon
|
|
||||||
```
|
|
||||||
</Step>
|
|
||||||
</Steps>
|
|
||||||
|
|
||||||
For deeper development workflows, see [Setup](/start/setup).
|
```bash
|
||||||
|
git clone https://github.com/openclaw/openclaw.git
|
||||||
|
cd openclaw
|
||||||
|
pnpm install && pnpm ui:build && pnpm build
|
||||||
|
pnpm link --global
|
||||||
|
openclaw onboard --install-daemon
|
||||||
|
```
|
||||||
|
|
||||||
</Accordion>
|
Or skip the link and use `pnpm openclaw ...` from inside the repo. See [Setup](/start/setup) for full development workflows.
|
||||||
</AccordionGroup>
|
|
||||||
|
|
||||||
## Other install methods
|
### Install from GitHub main
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install -g github:openclaw/openclaw#main
|
||||||
|
```
|
||||||
|
|
||||||
|
### Containers and package managers
|
||||||
|
|
||||||
<CardGroup cols={2}>
|
<CardGroup cols={2}>
|
||||||
<Card title="Docker" href="/install/docker" icon="container">
|
<Card title="Docker" href="/install/docker" icon="container">
|
||||||
Containerized or headless deployments.
|
Containerized or headless deployments.
|
||||||
</Card>
|
</Card>
|
||||||
<Card title="Podman" href="/install/podman" icon="container">
|
<Card title="Podman" href="/install/podman" icon="container">
|
||||||
Rootless container: run `setup-podman.sh` once, then the launch script.
|
Rootless container alternative to Docker.
|
||||||
</Card>
|
</Card>
|
||||||
<Card title="Nix" href="/install/nix" icon="snowflake">
|
<Card title="Nix" href="/install/nix" icon="snowflake">
|
||||||
Declarative install via Nix.
|
Declarative install via Nix flake.
|
||||||
</Card>
|
</Card>
|
||||||
<Card title="Ansible" href="/install/ansible" icon="server">
|
<Card title="Ansible" href="/install/ansible" icon="server">
|
||||||
Automated fleet provisioning.
|
Automated fleet provisioning.
|
||||||
@@ -170,50 +125,32 @@ For VPS/cloud hosts, avoid third-party "1-click" marketplace images when possibl
|
|||||||
</Card>
|
</Card>
|
||||||
</CardGroup>
|
</CardGroup>
|
||||||
|
|
||||||
## After install
|
## Verify the install
|
||||||
|
|
||||||
Verify everything is working:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
openclaw --version # confirm the CLI is available
|
||||||
openclaw doctor # check for config issues
|
openclaw doctor # check for config issues
|
||||||
openclaw status # gateway status
|
openclaw gateway status # verify the Gateway is running
|
||||||
openclaw dashboard # open the browser UI
|
|
||||||
```
|
```
|
||||||
|
|
||||||
If you need custom runtime paths, use:
|
## Hosting and deployment
|
||||||
|
|
||||||
- `OPENCLAW_HOME` for home-directory based internal paths
|
Deploy OpenClaw on a cloud server or VPS:
|
||||||
- `OPENCLAW_STATE_DIR` for mutable state location
|
|
||||||
- `OPENCLAW_CONFIG_PATH` for config file location
|
|
||||||
|
|
||||||
See [Environment vars](/help/environment) for precedence and full details.
|
<CardGroup cols={3}>
|
||||||
|
<Card title="VPS" href="/vps">Any Linux VPS</Card>
|
||||||
|
<Card title="Docker VM" href="/install/docker-vm-runtime">Shared Docker steps</Card>
|
||||||
|
<Card title="Kubernetes" href="/install/kubernetes">K8s</Card>
|
||||||
|
<Card title="Fly.io" href="/install/fly">Fly.io</Card>
|
||||||
|
<Card title="Hetzner" href="/install/hetzner">Hetzner</Card>
|
||||||
|
<Card title="GCP" href="/install/gcp">Google Cloud</Card>
|
||||||
|
<Card title="Azure" href="/install/azure">Azure</Card>
|
||||||
|
<Card title="Railway" href="/install/railway">Railway</Card>
|
||||||
|
<Card title="Render" href="/install/render">Render</Card>
|
||||||
|
<Card title="Northflank" href="/install/northflank">Northflank</Card>
|
||||||
|
</CardGroup>
|
||||||
|
|
||||||
## Troubleshooting: `openclaw` not found
|
## Update, migrate, or uninstall
|
||||||
|
|
||||||
<Accordion title="PATH diagnosis and fix">
|
|
||||||
Quick diagnosis:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
node -v
|
|
||||||
npm -v
|
|
||||||
npm prefix -g
|
|
||||||
echo "$PATH"
|
|
||||||
```
|
|
||||||
|
|
||||||
If `$(npm prefix -g)/bin` (macOS/Linux) or `$(npm prefix -g)` (Windows) is **not** in your `$PATH`, your shell can't find global npm binaries (including `openclaw`).
|
|
||||||
|
|
||||||
Fix — add it to your shell startup file (`~/.zshrc` or `~/.bashrc`):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
export PATH="$(npm prefix -g)/bin:$PATH"
|
|
||||||
```
|
|
||||||
|
|
||||||
On Windows, add the output of `npm prefix -g` to your PATH.
|
|
||||||
|
|
||||||
Then open a new terminal (or `rehash` in zsh / `hash -r` in bash).
|
|
||||||
</Accordion>
|
|
||||||
|
|
||||||
## Update / uninstall
|
|
||||||
|
|
||||||
<CardGroup cols={3}>
|
<CardGroup cols={3}>
|
||||||
<Card title="Updating" href="/install/updating" icon="refresh-cw">
|
<Card title="Updating" href="/install/updating" icon="refresh-cw">
|
||||||
@@ -226,3 +163,21 @@ Then open a new terminal (or `rehash` in zsh / `hash -r` in bash).
|
|||||||
Remove OpenClaw completely.
|
Remove OpenClaw completely.
|
||||||
</Card>
|
</Card>
|
||||||
</CardGroup>
|
</CardGroup>
|
||||||
|
|
||||||
|
## Troubleshooting: `openclaw` not found
|
||||||
|
|
||||||
|
If the install succeeded but `openclaw` is not found in your terminal:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
node -v # Node installed?
|
||||||
|
npm prefix -g # Where are global packages?
|
||||||
|
echo "$PATH" # Is the global bin dir in PATH?
|
||||||
|
```
|
||||||
|
|
||||||
|
If `$(npm prefix -g)/bin` is not in your `$PATH`, add it to your shell startup file (`~/.zshrc` or `~/.bashrc`):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export PATH="$(npm prefix -g)/bin:$PATH"
|
||||||
|
```
|
||||||
|
|
||||||
|
Then open a new terminal. See [Node setup](/install/node) for more details.
|
||||||
|
|||||||
Reference in New Issue
Block a user